From 2eb114118d0938baaa8a4cd3494173b5d87a6f46 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=AE=B8=E6=96=87=E6=B6=9B?= Date: Tue, 23 Jun 2020 12:25:15 +0800 Subject: [PATCH] docs: fix image link (#127) * docs: fix image link * docs: using Chinese as default --- README.zh-CN.md => README.en.md | 48 +++++++++---------- README.md | 48 ++++++++++--------- extensions/iceworks-material-helper/README.md | 2 +- .../iceworks-material-helper/package.json | 18 ++++--- 4 files changed, 62 insertions(+), 54 deletions(-) rename README.zh-CN.md => README.en.md (62%) diff --git a/README.zh-CN.md b/README.en.md similarity index 62% rename from README.zh-CN.md rename to README.en.md index 2047ed179..b6e6730eb 100644 --- a/README.zh-CN.md +++ b/README.en.md @@ -1,5 +1,4 @@ - -[English](./README.md) | 简体中文 +English | [简体中文](./README.md)

@@ -9,61 +8,62 @@

Iceworks

-

多端研发套件

+

Universal Application Development Pack

+ Test Coverage PRs Welcome GitHub license

-## 快速开始 +## Quick Start -### Iceworks 套件 +### Iceworks Pack -使用 VS Code 套件快速开发多端项目。 +Use VC Code pack to develop Universal Application projects quickly. ![Iceworks](https://img.alicdn.com/tfs/TB12Z1jJFP7gK0jSZFjXXc5aXXa-2880-1754.png) -1. 打开 VS Code 套件市场中的 [Iceworks](https://marketplace.visualstudio.com/items?itemName=iceworks-team.iceworks) 页面； -2. 点击页面上的「安装」按钮； -3. 安装成功后，点击 VS Code 界面左侧活动栏上的「iceworks 图标」，开始使用。 +1. Open [Iceworks Pack](https://marketplace.visualstudio.com/items?itemName=iceworks-team.iceworks) in VS Code Marketplace +2. Click the ["install"](vscode:extension/iceworks-team.iceworks) button on page +3. After installation is successful, click the "Iceworks icon" on Activity Bar of VS Code interface to start -查看 [Iceworks Pack 文档](extensions/iceworks/README.md)阅读更多详细介绍。 +See the [Iceworks Pack](extensions/iceworks/README.md) for more details. ### Iceworks CLI -使用 CLI 开发自定义物料集合。 +Use CLI to develop custom material collections. -- 安装工具： +- Installation: ```bash $ npm i -g iceworks ``` -- 初始化物料集合： +- Initialize material collections ``` $ mkdir materials-example && cd materials-example $ iceworks init material ``` -更多详细说明，请参考[《物料开发》](https://ice.work/docs/materials/about)。 +See [《物料开发》](https://ice.work/docs/materials/about) for more details. -## 参与贡献 +## Contributors -欢迎通过 [issue](https://github.com/ice-lab/iceworks/issues/new) 反馈问题。 +Feel free to report any questions as an [issue](https://github.com/ice-lab/iceworks/issues/new), we'd love to have your helping hand on icestore. -如果对 `Iceworks` 感兴趣，请参考 [CONTRIBUTING.md](./.github/CONTRIBUTING.md) 学习如何贡献代码。 +If you're interested in icestore, see [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for more information to learn how to get started. -## ICE 生态 +## ICE Ecosystem | Project | Version | Docs | Description | |----------------|------------------|--------------|-----------| -| [icejs] | [![icejs-status]][icejs-package] | [docs][icejs-docs] | 基于 React 的企业级研发框架 | -| [icestark] | [![icestark-status]][icestark-package] | [docs][icestark-docs] | 面向大型应用的微前端解决方案 | -| [icestore] | [![icestore-status]][icestore-package] | [docs][icestore-docs] | 简单友好的轻量级状态管理方案 | -| [formily] | [![formily-status]][formily-package] | [docs][formily-docs] | 能力完备性能出众的表单解决方案 | +| [icejs] | [![icejs-status]][icejs-package] | [docs][icejs-docs] | A universal framework based on react.js | +| [icestark] | [![icestark-status]][icestark-package] | [docs][icestark-docs] | Micro Frontends solution for large application | +| [icestore] | [![icestore-status]][icestore-package] | [docs][icestore-docs] | Simple and friendly state for React | +| [formily] | [![formily-status]][formily-package] | [docs][formily-docs] | Alibaba Group Unified Form Solution | [icejs]: https://github.com/alibaba/ice [icestark]: https://github.com/ice-lab/icestark @@ -85,9 +85,9 @@ [icestore-docs]: https://github.com/ice-lab/icestore#icestore [formily-docs]: https://formilyjs.org/ -## 社区 +## Community -| 钉钉群 | GitHub issues | Gitter | +| DingTalk community | GitHub issues | Gitter | |-------------------------------------|--------------|---------| | | [issues] | [gitter]| diff --git a/README.md b/README.md index 4888d04ee..f42ecf0a6 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -English | [简体中文](./README.zh-CN.md) + +简体中文 | [English](./README.en.md)

@@ -8,61 +9,62 @@ English | [简体中文](./README.zh-CN.md)

Iceworks

-

Universal Application Development Pack

+

多端研发套件

+ Test Coverage PRs Welcome GitHub license

-## Quick Start +## 快速开始 -### Iceworks Pack +### Iceworks 套件 -Use VC Code pack to develop Universal Application projects quickly. +使用 VS Code 套件快速开发多端项目。 ![Iceworks](https://img.alicdn.com/tfs/TB12Z1jJFP7gK0jSZFjXXc5aXXa-2880-1754.png) -1. Open [Iceworks Pack](https://marketplace.visualstudio.com/items?itemName=iceworks-team.iceworks) in VS Code Marketplace -2. Click the "install" button on page -3. After installation is successful, click the "Iceworks icon" on Activity Bar of VS Code interface to start +1. 打开 VS Code 套件市场中的 [Iceworks](https://marketplace.visualstudio.com/items?itemName=iceworks-team.iceworks) 页面； +2. 点击页面上的[「安装」](vscode:extension/iceworks-team.iceworks)按钮； +3. 安装成功后，点击 VS Code 界面左侧活动栏上的「iceworks 图标」，开始使用。 -See the [Iceworks Pack](extensions/iceworks/README.md) for more details. +查看 [Iceworks Pack 文档](extensions/iceworks/README.md)阅读更多详细介绍。 ### Iceworks CLI -Use CLI to develop custom material collections. +使用 CLI 开发自定义物料集合。 -- Installation: +- 安装工具： ```bash $ npm i -g iceworks ``` -- Initialize material collections +- 初始化物料集合： ``` $ mkdir materials-example && cd materials-example $ iceworks init material ``` -See [《物料开发》](https://ice.work/docs/materials/about) for more details. +更多详细说明，请参考[《物料开发》](https://ice.work/docs/materials/about)。 -## Contributors +## 参与贡献 -Feel free to report any questions as an [issue](https://github.com/ice-lab/iceworks/issues/new), we'd love to have your helping hand on icestore. +欢迎通过 [issue](https://github.com/ice-lab/iceworks/issues/new) 反馈问题。 -If you're interested in icestore, see [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for more information to learn how to get started. +如果对 `Iceworks` 感兴趣，请参考 [CONTRIBUTING.md](./.github/CONTRIBUTING.md) 学习如何贡献代码。 -## ICE Ecosystem +## ICE 生态 | Project | Version | Docs | Description | |----------------|------------------|--------------|-----------| -| [icejs] | [![icejs-status]][icejs-package] | [docs][icejs-docs] | A universal framework based on react.js | -| [icestark] | [![icestark-status]][icestark-package] | [docs][icestark-docs] | Micro Frontends solution for large application | -| [icestore] | [![icestore-status]][icestore-package] | [docs][icestore-docs] | Simple and friendly state for React | -| [formily] | [![formily-status]][formily-package] | [docs][formily-docs] | Alibaba Group Unified Form Solution | +| [icejs] | [![icejs-status]][icejs-package] | [docs][icejs-docs] | 基于 React 的企业级研发框架 | +| [icestark] | [![icestark-status]][icestark-package] | [docs][icestark-docs] | 面向大型应用的微前端解决方案 | +| [icestore] | [![icestore-status]][icestore-package] | [docs][icestore-docs] | 简单友好的轻量级状态管理方案 | +| [formily] | [![formily-status]][formily-package] | [docs][formily-docs] | 能力完备性能出众的表单解决方案 | [icejs]: https://github.com/alibaba/ice [icestark]: https://github.com/ice-lab/icestark @@ -84,9 +86,9 @@ If you're interested in icestore, see [CONTRIBUTING.md](./.github/CONTRIBUTING.m [icestore-docs]: https://github.com/ice-lab/icestore#icestore [formily-docs]: https://formilyjs.org/ -## Community +## 社区 -| DingTalk community | GitHub issues | Gitter | +| 钉钉群 | GitHub issues | Gitter | |-------------------------------------|--------------|---------| | | [issues] | [gitter]| diff --git a/extensions/iceworks-material-helper/README.md b/extensions/iceworks-material-helper/README.md index 280778e27..126c921c3 100644 --- a/extensions/iceworks-material-helper/README.md +++ b/extensions/iceworks-material-helper/README.md @@ -10,7 +10,7 @@ 在 JSX 文件中编辑组件的属性时将给予自动补全提醒： -![使用示例]](https://img.alicdn.com/tfs/TB1pNj5x7Y2gK0jSZFgXXc5OFXa-1688-780.gif) +![使用示例](https://img.alicdn.com/tfs/TB1pNj5x7Y2gK0jSZFgXXc5OFXa-1688-780.gif) ## 更多 diff --git a/extensions/iceworks-material-helper/package.json b/extensions/iceworks-material-helper/package.json index 82371f45a..e09c50a5e 100644 --- a/extensions/iceworks-material-helper/package.json +++ b/extensions/iceworks-material-helper/package.json @@ -3,11 +3,13 @@ "displayName": "Iceworks Material Helper", "description": "Easily use materials in JSX.", "publisher": "iceworks-team", - "version": "0.1.1", + "version": "0.1.2", + "main": "./build/index.js", "engines": { "vscode": "^1.41.0" }, "categories": [ + "Programming Languages", "Other" ], "keywords": [ @@ -24,11 +26,6 @@ "onLanguage:typescript", "onLanguage:typescriptreact" ], - "repository": { - "type": "git", - "url": "https://github.com/ice-lab/iceworks.git" - }, - "main": "./build/index.js", "scripts": { "vscode:prepublish": "rm -rf build && npm run compile", "compile": "tsc -p ./", @@ -44,5 +41,14 @@ "@babel/parser": "^7.10.2", "@babel/traverse": "^7.10.1", "@babel/types": "^7.10.2" + }, + "repository": { + "type": "git", + "url": "https://github.com/ice-lab/iceworks.git" + }, + "homepage": "https://github.com/ice-lab/iceworks/blob/master/extensions/iceworks-material-helper/README.md", + "bugs": { + "url": "https://github.com/ice-lab/iceworks/issues", + "email": "iceworksteam@163.com" } }