From 333f63bd05db2d5dcc6e051022a5487cb2aa2082 Mon Sep 17 00:00:00 2001 From: afc163 Date: Mon, 16 Dec 2019 22:42:08 +0800 Subject: [PATCH] :memo: improve antd features in README --- README-zh_CN.md | 31 +++++++++++++++++++------------ README.md | 28 ++++++++++++++++++---------- docs/react/introduce.en-US.md | 14 ++++++++------ docs/react/introduce.zh-CN.md | 14 ++++++++------ 4 files changed, 53 insertions(+), 34 deletions(-) diff --git a/README-zh_CN.md b/README-zh_CN.md index 4ef823884f..8c8363235a 100644 --- a/README-zh_CN.md +++ b/README-zh_CN.md @@ -24,10 +24,12 @@ ## ✨ 特性 -- 提炼自企业级中后台产品的交互语言和视觉风格。 -- 开箱即用的高质量 React 组件。 -- 使用 TypeScript 构建，提供完整的类型定义文件。 -- 全链路开发和设计工具体系。 +- 🌈 提炼自企业级中后台产品的交互语言和视觉风格。 +- 📦 开箱即用的高质量 React 组件。 +- 🛡 使用 TypeScript 开发，提供完整的类型定义文件。 +- ⚙️ 全链路开发和设计工具体系。 +- 🌍 数十个国际化语言支持。 +- 🎨 深入每个细节的主题定制能力。 ## 🖥 支持环境 @@ -51,20 +53,25 @@ yarn add antd ## 🔨 示例 -```jsx -import { DatePicker } from 'antd'; -ReactDOM.render(, mountNode); -``` +````jsx +import { Button, DatePicker } from 'antd'; + +const App = () => ( + <> + + + +); 引入样式： ```jsx import 'antd/dist/antd.css'; // or 'antd/dist/antd.less' -``` +```` -你也可以 [按需加载组件](https://ant.design/docs/react/getting-started-cn#按需加载)。 +你也可以使用 [babel-plugin-import](https://ant.design/docs/react/getting-started-cn#按需加载)。 -### TypeScript +### 🛡 TypeScript 参考 [在 TypeScript 中使用](https://ant.design/docs/react/use-in-typescript-cn) @@ -121,7 +128,7 @@ $ npm start [![Let's fund issues in this repository](https://issuehunt.io/static/embed/issuehunt-button-v1.svg)](https://issuehunt.io/repos/34526884) -## 社区互助 +## 👥 社区互助 如果您在使用的过程中碰到问题，可以通过下面几个途径寻求帮助，同时我们也鼓励资深用户通过下面的途径给新人提供帮助。 diff --git a/README.md b/README.md index c86ea47585..adedb1d332 100644 --- a/README.md +++ b/README.md @@ -24,10 +24,12 @@ English | [简体中文](./README-zh_CN.md) ## ✨ Features -- An enterprise-class UI design system for web 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. +- 🌈 Enterprise-class UI designed for web 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. +- 🌍 Internationalization support for dozens of languages. +- 🎨 Powerful theme customization in every detail. ## 🖥 Environment Support @@ -36,8 +38,8 @@ English | [简体中文](./README-zh_CN.md) - [Electron](http://electron.atom.io/) | [IE / Edge](http://godban.github.io/browsers-support-badges/)
IE / Edge | [Firefox](http://godban.github.io/browsers-support-badges/)
Firefox | [Chrome](http://godban.github.io/browsers-support-badges/)
Chrome | [Safari](http://godban.github.io/browsers-support-badges/)
Safari | [Opera](http://godban.github.io/browsers-support-badges/)
Opera | [Electron](http://godban.github.io/browsers-support-badges/)
Electron | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| IE9, IE10, IE11, Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions | last 2 versions | +| --- | --- | --- | --- | --- | --- | +| IE9, IE10, IE11, Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions | last 2 versions | ## 📦 Install @@ -52,17 +54,23 @@ yarn add antd ## 🔨 Usage ```jsx -import { DatePicker } from "antd"; -ReactDOM.render(, mountNode); +import { Button, DatePicker } from 'antd'; + +const App = () => ( + <> + + + +); ``` And import style manually: ```jsx -import "antd/dist/antd.css"; // or 'antd/dist/antd.less' +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 use [babel-plugin-import](https://ant.design/docs/react/getting-started#Import-on-Demand). ### TypeScript diff --git a/docs/react/introduce.en-US.md b/docs/react/introduce.en-US.md index 80f9458277..6844d6edfb 100644 --- a/docs/react/introduce.en-US.md +++ b/docs/react/introduce.en-US.md @@ -25,12 +25,14 @@ Following the Ant Design specification, we developed a React UI library `antd` t --- -## Features - -- An enterprise-class UI design language for web applications. -- A set of high-quality React components out of the box. -- Written in TypeScript with complete defined types. -- The whole package of development and design resources and tools. +## ✨ Features + +- 🌈 Enterprise-class UI designed for web 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. +- 🌍 Internationalization support for dozens of languages. +- 🎨 Powerful theme customization in every detail. ## Environment Support diff --git a/docs/react/introduce.zh-CN.md b/docs/react/introduce.zh-CN.md index 7318e7a6a0..2341583311 100644 --- a/docs/react/introduce.zh-CN.md +++ b/docs/react/introduce.zh-CN.md @@ -25,12 +25,14 @@ title: Ant Design of React --- -## 特性 - -- 提炼自企业级中后台产品的交互语言和视觉风格。 -- 开箱即用的高质量 React 组件。 -- 使用 TypeScript 构建，提供完整的类型定义文件。 -- 全链路开发和设计工具体系。 +## ✨ 特性 + +- 🌈 提炼自企业级中后台产品的交互语言和视觉风格。 +- 📦 开箱即用的高质量 React 组件。 +- 🛡 使用 TypeScript 开发，提供完整的类型定义文件。 +- ⚙️ 全链路开发和设计工具体系。 +- 🌍 数十个国际化语言支持。 +- 🎨 深入每个细节的主题定制能力。 ## 支持环境