ant-design/README-zh_CN.md

112 lines
5.5 KiB
Markdown
Raw Normal View History

<p align="center">
<a href="http://ant.design">
2017-11-28 11:17:38 +08:00
<img width="230" src="https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg">
</a>
</p>
2016-10-17 09:37:55 +08:00
# Ant Design
2016-11-22 14:56:55 +08:00
2016-10-17 09:37:55 +08:00
[![](https://img.shields.io/travis/ant-design/ant-design.svg?style=flat-square)](https://travis-ci.org/ant-design/ant-design)
2017-03-08 14:32:29 +08:00
[![Codecov](https://img.shields.io/codecov/c/github/ant-design/ant-design/master.svg?style=flat-square)](https://codecov.io/gh/ant-design/ant-design/branch/master)
2017-01-30 18:09:37 +08:00
[![Dependency Status](https://img.shields.io/gemnasium/react-component/trigger.svg?style=flat-square)](https://gemnasium.com/ant-design/ant-design)
2016-11-22 14:56:55 +08:00
2016-11-22 15:02:21 +08:00
[![npm package](https://img.shields.io/npm/v/antd.svg?style=flat-square)](https://www.npmjs.org/package/antd)
[![NPM downloads](http://img.shields.io/npm/dm/antd.svg?style=flat-square)](https://npmjs.org/package/antd)
2017-03-10 19:28:13 +08:00
[![Percentage of issues still open](http://isitmaintained.com/badge/open/ant-design/ant-design.svg)](http://isitmaintained.com/project/ant-design/ant-design "Percentage of issues still open")
2017-04-11 18:07:53 +08:00
[![Gitter](https://badges.gitter.im/ant-design/ant-design-english.svg)](https://gitter.im/ant-design/ant-design-english?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) (English)
[![Join the chat at https://gitter.im/ant-design/ant-design](https://img.shields.io/gitter/room/ant-design/ant-design.svg?style=flat-square)](https://gitter.im/ant-design/ant-design?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)(中文)
2015-12-06 17:40:04 +08:00
一套企业级的 UI 设计语言和 React 实现。
2016-12-23 18:06:28 +08:00
[README in English](README.md)
## 特性
2017-01-22 01:15:14 +08:00
- 提炼自企业级中后台产品的交互语言和视觉风格。
- 开箱即用的高质量 React 组件。
2016-09-29 14:42:38 +08:00
- 使用 TypeScript 构建,提供完整的类型定义文件。
2017-01-17 00:11:22 +08:00
- 基于 npm + webpack + [dva](https://github.com/dvajs/dva) 的企业级开发框架。
2017-03-13 15:49:15 +08:00
## 支持环境
* 现代浏览器和 IE9 及以上。
* 支持服务端渲染。
* [Electron](http://electron.atom.io/)
## 参与共建 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
`antd` 是一个开源项目,我们欢迎社区参与共建。如果你对此项目感兴趣,有 [很多方式](https://opensource.guide/how-to-contribute/) 进行参与。你可以 watch 这个仓库,加入 [issue 中的讨论](https://github.com/ant-design/ant-design/issues?q=is%3Aopen+is%3Aissue+label%3ADiscussion),以及尝试实现一些 [已接受的特性](https://github.com/ant-design/ant-design/issues?q=is%3Aopen+is%3Aissue+label%3A%22PR+welcome%22)。我们会给予有活跃贡献的社区成员 [collaborator 权限](https://github.com/ant-design/ant-design/issues/3222)。
2015-11-02 20:37:38 +08:00
## 安装
```bash
2017-12-04 14:57:30 +08:00
npm install antd --save
2015-11-02 20:37:38 +08:00
```
## 示例
2015-12-16 15:04:51 +08:00
```jsx
import { DatePicker } from 'antd';
ReactDOM.render(<DatePicker />, mountNode);
```
2015-10-27 22:17:54 +08:00
2015-12-08 18:05:01 +08:00
引入样式:
```jsx
import 'antd/dist/antd.css'; // or 'antd/dist/antd.less'
2015-12-08 18:05:01 +08:00
```
2017-12-04 14:57:30 +08:00
你也可以[按需加载组件](https://ant.design/docs/react/getting-started-cn#按需加载)。
2015-12-16 15:04:51 +08:00
## TypeScript
2017-11-29 20:27:52 +08:00
参考 [在 TypeScript 中使用](https://ant.design/docs/react/use-in-typescript-cn)
2016-12-04 14:16:10 +08:00
2017-03-12 15:20:25 +08:00
## 国际化
2017-11-29 20:27:52 +08:00
参考 [国际化文档](http://ant.design/docs/react/i18n-cn)。
2017-03-12 15:20:25 +08:00
## 链接
2017-11-01 10:50:27 +08:00
- [首页](http://ant.design/)
- [组件库](http://ant.design/docs/react/introduce)
- [Ant Design Pro](http://pro.ant.design/)
2016-11-14 11:08:26 +08:00
- [更新日志](CHANGELOG.en-US.md)
2017-05-13 16:12:35 +08:00
- [脚手架市场](http://scaffold.ant.design)
2017-03-12 15:20:25 +08:00
- [React 底层基础组件](http://react-component.github.io/)
2016-07-29 13:52:05 +08:00
- [移动端组件](http://mobile.ant.design)
2016-11-14 11:08:26 +08:00
- [动效](https://motion.ant.design)
2017-02-15 13:50:03 +08:00
- [设计规范速查手册](https://github.com/ant-design/ant-design/wiki/Ant-Design-%E8%AE%BE%E8%AE%A1%E5%9F%BA%E7%A1%80%E7%AE%80%E7%89%88)
2016-11-14 11:08:26 +08:00
- [开发者说明](https://github.com/ant-design/ant-design/wiki/Development)
- [版本发布规则](https://github.com/ant-design/ant-design/wiki/%E8%BD%AE%E5%80%BC%E8%A7%84%E5%88%99%E5%92%8C%E7%89%88%E6%9C%AC%E5%8F%91%E5%B8%83%E6%B5%81%E7%A8%8B)
2016-08-11 16:45:15 +08:00
- [常见问题](https://github.com/ant-design/ant-design/wiki/FAQ)
2017-11-29 20:27:52 +08:00
- [CodeSandbox 模板](https://u.ant.design/codesandbox-repro) for bug reports
2016-08-11 16:45:15 +08:00
- [Awesome Ant Design](https://github.com/websemantics/awesome-ant-design)
2017-01-31 21:12:52 +08:00
- [定制主题](http://ant.design/docs/react/customize-theme-cn)
2016-06-23 13:27:23 +08:00
2017-03-29 11:34:21 +08:00
## 本地开发
```bash
$ git clone git@github.com:ant-design/ant-design.git
$ npm install
$ npm start
```
打开浏览器访问 http://127.0.0.1:8001 ,更多本地开发文档参见: https://github.com/ant-design/ant-design/wiki/Development 。
## 如何贡献
2017-12-15 11:31:51 +08:00
阅读我们的[贡献指南](./.github/CONTRIBUTING.md).
2017-03-24 20:15:51 +08:00
2017-06-01 14:12:26 +08:00
> 强烈推荐阅读 [《提问的智慧》](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),更好的问题更容易获得帮助。
2017-03-24 20:15:51 +08:00
## 社区互助
如果您在使用的过程中碰到问题,可以通过下面几个途径寻求帮助,同时我们也鼓励资深用户通过下面的途径给新人提供帮助。
通过 Stack Overflow 或者 Segment Fault 提问时,建议加上 `antd` 标签。
1. [Stack Overflow](http://stackoverflow.com/questions/tagged/antd)(英文)
2. [Segment Fault](https://segmentfault.com/t/antd)(中文)
3. [![Join the chat at https://gitter.im/ant-design/ant-design](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ant-design/ant-design?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)