From 2b95fd2d739aaef4efaff504ecab26e2fb179299 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=84=B6=E5=88=99?= Date: Thu, 4 May 2017 18:32:27 +0800 Subject: [PATCH] translate getting-started doc, delete install doc, ref #329 --- CHANGELOG.en-US.md | 2 +- CHANGELOG.zh-CN.md | 2 +- docs/react/getting-started.en-US.md | 32 ++++++++++++++------------ docs/react/getting-started.zh-CN.md | 4 ++-- docs/react/install.en-US.md | 27 ---------------------- docs/react/install.zh-CN.md | 27 ---------------------- docs/react/practical-projects.en-US.md | 2 +- docs/react/practical-projects.zh-CN.md | 2 +- docs/react/upgrade-notes.en-US.md | 2 +- docs/react/upgrade-notes.zh-CN.md | 2 +- 10 files changed, 25 insertions(+), 77 deletions(-) delete mode 100644 docs/react/install.en-US.md delete mode 100644 docs/react/install.zh-CN.md diff --git a/CHANGELOG.en-US.md b/CHANGELOG.en-US.md index f9fde2c4929..c09e440addd 100644 --- a/CHANGELOG.en-US.md +++ b/CHANGELOG.en-US.md @@ -1,5 +1,5 @@ --- -order: 4 +order: 3 title: Change Log timeline: true --- diff --git a/CHANGELOG.zh-CN.md b/CHANGELOG.zh-CN.md index b2660244f42..2040367ec82 100644 --- a/CHANGELOG.zh-CN.md +++ b/CHANGELOG.zh-CN.md @@ -1,5 +1,5 @@ --- -order: 4 +order: 3 title: 更新日志 timeline: true --- diff --git a/docs/react/getting-started.en-US.md b/docs/react/getting-started.en-US.md index f63d73befbe..9178b766e52 100644 --- a/docs/react/getting-started.en-US.md +++ b/docs/react/getting-started.en-US.md @@ -3,32 +3,34 @@ order: 1 title: Getting Started --- -Ant Design React 致力于提供给程序员**愉悦**的开发体验。 +Ant Design React is dedicated to providing a good development experience for programmers. --- -在开始之前，推荐先学习 [React](http://facebook.github.io/react/) 和 [ES2015](http://babeljs.io/docs/learn-es2015/)。 +Before delving into Ant Design React, a good knowledge of [React](http://facebook.github.io/react/) and [ES2015](http://babeljs.io/docs/learn-es2015/) is needed. -### 1. 安装工具 -确认 [Node.js](https://nodejs.org/en/) 已经升级到 v4.x 或以上。 +### 1. Installation +Make sure that you had installed [Node.js](https://nodejs.org/en/)(> v4.x) correctly. -### 2. 创建一个项目 +### 2. Create a New Project -手动从脚手架工具里拷贝 [MobileDemo](https://github.com/ant-design/antd-mobile-samples/tree/master/rn-web) +Copy and modify from [here](https://github.com/ant-design/antd-mobile-samples/tree/master/rn-web). -### 3. 使用组件 +### 3. Use Components -[见此使用示例](/docs/react/introduce#使用) +[See here for details](/docs/react/introduce#使用). -### 4. 开发调试 & 构建和部署 +### 4. Development & Debugging & Building & Deployment -Web 和 React Native 两种使用方式有区别，按照 readme 文档说明分别使用 +Web and React Native are used in two ways, and are used separately according to the README documentation. -## 自行构建 +## Customized Work Flow -如果想自己维护工作流，我们推荐使用 [webpack](http://webpack.github.io/) 进行构建和调试。理论上你可以利用 React 生态圈中的 [各种脚手架](https://github.com/enaqx/awesome-react#boilerplates) 进行开发，如果遇到问题可参考我们所使用的 [webpack 配置](https://github.com/ant-tool/atool-build/blob/master/src/getWebpackCommonConfig.js) 进行 [定制](http://ant-tool.github.io/webpack-config.html)。 +If you want to customize your work flow, we recommend to use [webpack](http://webpack.github.io/) to build and debug code. -## 小甜点 +Also, you can use any [scaffold](https://github.com/enaqx/awesome-react#boilerplates) available in React ecosystem. If you encounter problems, you can use our [webpack config](https://github.com/ant-tool/atool-build/blob/master/src/getWebpackCommonConfig.js) and [modify it](http://ant-tool.github.io/webpack-config.html). -- 你可以享用 `npm` 生态圈里的所有模块。 -- 我们使用了 `babel`，试试用 [ES2015](http://babeljs.io/blog/2015/06/07/react-on-es6-plus) 的写法来提升编码的愉悦感。 +## Tips + +- You can use any `npm` modules. +- We recommend to write code in [ES2015](http://babeljs.io/blog/2015/06/07/react-on-es6-plus) as `babel` has been integrated in our work flow. diff --git a/docs/react/getting-started.zh-CN.md b/docs/react/getting-started.zh-CN.md index 184ec60dcc7..b1ef4093d19 100644 --- a/docs/react/getting-started.zh-CN.md +++ b/docs/react/getting-started.zh-CN.md @@ -14,7 +14,7 @@ Ant Design React 致力于提供给程序员**愉悦**的开发体验。 ### 2. 创建一个项目 -手动从脚手架工具里拷贝 [MobileDemo](https://github.com/ant-design/antd-mobile-samples/tree/master/rn-web) +从 [这里](https://github.com/ant-design/antd-mobile-samples/tree/master/rn-web) 拷贝并修改 ### 3. 使用组件 @@ -22,7 +22,7 @@ Ant Design React 致力于提供给程序员**愉悦**的开发体验。 ### 4. 开发调试 & 构建和部署 -Web 和 React Native 两种使用方式有区别，按照 readme 文档说明分别使用 +Web 和 React Native 两种使用方式有区别，按照 README 文档说明分别使用。 ## 自行构建 diff --git a/docs/react/install.en-US.md b/docs/react/install.en-US.md deleted file mode 100644 index 94896ab59af..00000000000 --- a/docs/react/install.en-US.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -order: 2 -title: Install ---- - -## 使用 npm 安装 - -**我们推荐使用 npm 的方式进行开发**，不仅可在开发环境轻松调试，也可放心地在生产环境打包部署使用，享受整个生态圈和工具链带来的诸多好处。 - -可以通过 npm 直接安装到项目中，使用 `import` 或 `require` 进行引用。 - -```bash -$ npm install antd-mobile --save -``` - -## 浏览器引入 - -我们在 npm 发布包内的 `antd-mobile/dist` 目录下提供了 `antd-mobile.js` `antd-mobile.css` 以及 `antd-mobile.min.js` `antd-mobile.min.css` 用于一次性引入所有的 antd-mobile 组件，也可以通过 [UNPKG](https://unpkg.com/) 进行下载。 - -**不要一次性引入全部代码，更好做法请查看 introduce - install & usage** - -#### stable - -- https://unpkg.com/antd-mobile/dist/antd-mobile.js -- https://unpkg.com/antd-mobile/dist/antd-mobile.css -- https://unpkg.com/antd-mobile/dist/antd-mobile.min.js -- https://unpkg.com/antd-mobile/dist/antd-mobile.min.css diff --git a/docs/react/install.zh-CN.md b/docs/react/install.zh-CN.md deleted file mode 100644 index 0bb3fa05b8a..00000000000 --- a/docs/react/install.zh-CN.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -order: 2 -title: 安装 ---- - -## 使用 npm 安装 - -**我们推荐使用 npm 的方式进行开发**，不仅可在开发环境轻松调试，也可放心地在生产环境打包部署使用，享受整个生态圈和工具链带来的诸多好处。 - -可以通过 npm 直接安装到项目中，使用 `import` 或 `require` 进行引用。 - -```bash -$ npm install antd-mobile --save -``` - -## 浏览器引入 - -我们在 npm 发布包内的 `antd-mobile/dist` 目录下提供了 `antd-mobile.js` `antd-mobile.css` 以及 `antd-mobile.min.js` `antd-mobile.min.css` 用于一次性引入所有的 antd-mobile 组件，也可以通过 [UNPKG](https://unpkg.com/) 进行下载。 - -**不要一次性引入全部代码，更好做法请查看 introduce - install & usage** - -#### stable - -- https://unpkg.com/antd-mobile/dist/antd-mobile.js -- https://unpkg.com/antd-mobile/dist/antd-mobile.css -- https://unpkg.com/antd-mobile/dist/antd-mobile.min.js -- https://unpkg.com/antd-mobile/dist/antd-mobile.min.css diff --git a/docs/react/practical-projects.en-US.md b/docs/react/practical-projects.en-US.md index 8a1c9cb8bbf..d95d45eb50f 100644 --- a/docs/react/practical-projects.en-US.md +++ b/docs/react/practical-projects.en-US.md @@ -1,5 +1,5 @@ --- -order: 3 +order: 2 title: Real project with Dva --- diff --git a/docs/react/practical-projects.zh-CN.md b/docs/react/practical-projects.zh-CN.md index 62245d23a91..2f8034631e7 100644 --- a/docs/react/practical-projects.zh-CN.md +++ b/docs/react/practical-projects.zh-CN.md @@ -1,5 +1,5 @@ --- -order: 3 +order: 2 title: 项目实战 --- diff --git a/docs/react/upgrade-notes.en-US.md b/docs/react/upgrade-notes.en-US.md index 971b357800b..857dbebe765 100644 --- a/docs/react/upgrade-notes.en-US.md +++ b/docs/react/upgrade-notes.en-US.md @@ -1,5 +1,5 @@ --- -order: 5 +order: 4 title: Upgrade --- diff --git a/docs/react/upgrade-notes.zh-CN.md b/docs/react/upgrade-notes.zh-CN.md index 9203a6a6de5..d95d84f36c2 100644 --- a/docs/react/upgrade-notes.zh-CN.md +++ b/docs/react/upgrade-notes.zh-CN.md @@ -1,5 +1,5 @@ --- -order: 5 +order: 4 title: 升级指南 ---