From c0ecd050e8961e4b51b06d03ac078952f3989ac9 Mon Sep 17 00:00:00 2001 From: afc163 Date: Sun, 2 Sep 2018 12:30:15 +0800 Subject: [PATCH] beautify README --- README-zh_CN.md | 26 +++++++++++--------------- README.md | 30 ++++++++++++++---------------- 2 files changed, 25 insertions(+), 31 deletions(-) diff --git a/README-zh_CN.md b/README-zh_CN.md index d2d1d6df80..6c792328bc 100644 --- a/README-zh_CN.md +++ b/README-zh_CN.md @@ -26,14 +26,14 @@ [English](./README.md) | 简体中文 -## ✨ 特性 +### ✨ 特性 - 提炼自企业级中后台产品的交互语言和视觉风格。 - 开箱即用的高质量 React 组件。 - 使用 TypeScript 构建，提供完整的类型定义文件。 - 全链路开发和设计工具体系。 -## 🖥 支持环境 +### 🖥 支持环境 * 现代浏览器和 IE9 及以上。 * 支持服务端渲染。 @@ -43,17 +43,13 @@ | --------- | --------- | --------- | --------- | --------- | --------- | | IE9, IE10, IE11, Edge| last 2 versions| last 2 versions| last 2 versions| last 2 versions| last 2 versions -## 参与共建 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) - -请参考[贡献指南](https://ant.design/docs/react/contributing-cn). - -## 📦 安装 +### 📦 安装 ```bash npm install antd --save ``` -## 🔨 示例 +### 🔨 示例 ```jsx import { DatePicker } from 'antd'; @@ -68,15 +64,15 @@ import 'antd/dist/antd.css'; // or 'antd/dist/antd.less' 你也可以[按需加载组件](https://ant.design/docs/react/getting-started-cn#按需加载)。 -## TypeScript +#### TypeScript 参考 [在 TypeScript 中使用](https://ant.design/docs/react/use-in-typescript-cn) -## 🌍 国际化 +### 🌍 国际化 参考 [国际化文档](http://ant.design/docs/react/i18n-cn)。 -## 🔗 链接 +### 🔗 链接 - [首页](http://ant.design/) - [组件库](http://ant.design/docs/react/introduce) @@ -94,7 +90,7 @@ import 'antd/dist/antd.css'; // or 'antd/dist/antd.less' - [Awesome Ant Design](https://github.com/websemantics/awesome-ant-design) - [定制主题](http://ant.design/docs/react/customize-theme-cn) -## 本地开发 +### ⌨️ 本地开发 ```bash $ git clone git@github.com:ant-design/ant-design.git @@ -105,13 +101,13 @@ $ npm start 打开浏览器访问 http://127.0.0.1:8001 ，更多[本地开发文档](https://github.com/ant-design/ant-design/wiki/Development)。 -## 如何贡献 +### 🤝 参与共建 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) -阅读我们的[贡献指南](./.github/CONTRIBUTING.md). +请参考[贡献指南](https://ant.design/docs/react/contributing-cn). > 强烈推荐阅读 [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way)、[《如何向开源社区提问题》](https://github.com/seajs/seajs/issues/545) 和 [《如何有效地报告 Bug》](http://www.chiark.greenend.org.uk/%7Esgtatham/bugs-cn.html)、[《如何向开源项目提交无法解答的问题》](https://zhuanlan.zhihu.com/p/25795393)，更好的问题更容易获得帮助。 -## 社区互助 +### 社区互助 如果您在使用的过程中碰到问题，可以通过下面几个途径寻求帮助，同时我们也鼓励资深用户通过下面的途径给新人提供帮助。 diff --git a/README.md b/README.md index fc7073ad0b..05a80b957e 100644 --- a/README.md +++ b/README.md @@ -26,18 +26,18 @@ An enterprise-class UI design language and React-based implementation. English | [简体中文](./README-zh_CN.md) -## 3.0 Released Now! :tada::tada::tada: +### 3.0 Released Now! :tada::tada::tada: [Announcing Ant Design 3.0](https://medium.com/ant-design/announcing-ant-design-3-0-70e3e65eca0c) -## ✨ Features +### ✨ Features - An enterprise-class UI design system for desktop applications. - A set of high-quality React components out of the box. - Written in TypeScript with predictable static types. - The whole package of development and design resources and tools. -## 🖥 Environment Support +### 🖥 Environment Support * Modern browsers and Internet Explorer 9+ (with [polyfills](https://ant.design/docs/react/getting-started#Compatibility)) * Server-side Rendering @@ -47,17 +47,13 @@ English | [简体中文](./README-zh_CN.md) | --------- | --------- | --------- | --------- | --------- | --------- | | IE9, IE10, IE11, Edge| last 2 versions| last 2 versions| last 2 versions| last 2 versions| last 2 versions -## Let's build a better antd together [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) - -Read our [contributing guide](https://ant.design/docs/react/contributing). - -## 📦 Install +### 📦 Install ```bash npm install antd --save ``` -## 🔨 Usage +### 🔨 Usage ```jsx import { DatePicker } from 'antd'; @@ -70,17 +66,17 @@ And import style manually: import 'antd/dist/antd.css'; // or 'antd/dist/antd.less' ``` -Or [import components on demand](https://ant.design/docs/react/getting-started#Import-on-Demand) +Or [import components on demand](https://ant.design/docs/react/getting-started#Import-on-Demand). -### TypeScript +#### TypeScript -See [Use in TypeScript](https://ant.design/docs/react/use-in-typescript) +See [Use in TypeScript](https://ant.design/docs/react/use-in-typescript). -## 🌍 Internationalization +### 🌍 Internationalization See [i18n](http://ant.design/docs/react/i18n). -## 🔗 Links +### 🔗 Links - [Home page](http://ant.design/) - [Components](http://ant.design/docs/react/introduce) @@ -97,7 +93,7 @@ See [i18n](http://ant.design/docs/react/i18n). - [Awesome Ant Design](https://github.com/websemantics/awesome-ant-design) - [Customize Theme](http://ant.design/docs/react/customize-theme) -## Development +### ⌨️ Development ```bash $ git clone git@github.com:ant-design/ant-design.git @@ -108,6 +104,8 @@ $ npm start Open your browser and visit http://127.0.0.1:8001 , see more at [Development](https://github.com/ant-design/ant-design/wiki/Development). -## Contributing +### 🤝 Contributing [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) + +Read our [contributing guide](https://ant.design/docs/react/contributing) and let's build a better antd together. We welcome all contributions. Please read our [CONTRIBUTING.md](https://github.com/ant-design/ant-design/blob/master/.github/CONTRIBUTING.md) first. You can submit any ideas as [pull requests](https://github.com/ant-design/ant-design/pulls) or as [GitHub issues](https://github.com/ant-design/ant-design/issues). If you'd like to improve code, check out the [Development Instructions](https://github.com/ant-design/ant-design/wiki/Development) and have a good time! :)