mirror of
https://gitee.com/ant-design/ant-design.git
synced 2024-11-29 18:50:00 +08:00
update documentation
This commit is contained in:
parent
d2fac30c7f
commit
32b5035113
@ -1,15 +1,13 @@
|
||||
# Ant Design [![](https://img.shields.io/travis/ant-design/ant-design.svg?style=flat-square)](https://travis-ci.org/ant-design/ant-design) [![npm package](https://img.shields.io/npm/v/antd.svg?style=flat-square)](https://www.npmjs.org/package/antd) [![Dependency Status](https://david-dm.org/ant-design/ant-design.svg?style=flat-square)](https://david-dm.org/ant-design/ant-design)
|
||||
|
||||
An enterprise grade front-end development language and React-based implementation.
|
||||
|
||||
Design documents and component implementations are still being revised so several pages are not yet complete. We are currently planning a release version for August.
|
||||
An enterprise-class UI design language and React-based implementation.
|
||||
|
||||
![](https://t.alipayobjects.com/images/rmsweb/T11aVgXc4eXXXXXXXX.svg)
|
||||
|
||||
## Features
|
||||
|
||||
- An enterprise-grade graphical design language and framework for financial applications
|
||||
- Rich library of React UI components.
|
||||
- An enterprise-class graphical design language and framework for financial applications
|
||||
- Rich library of UI components base on [React Component](http://react-component.github.io/badgeboard/).
|
||||
- A Component development model based on React.
|
||||
- Backed by the npm ecosystem.
|
||||
- webpack-based debug builds supporting ES6
|
||||
@ -18,9 +16,7 @@ Design documents and component implementations are still being revised so severa
|
||||
## Usage example
|
||||
|
||||
```jsx
|
||||
var antd = require('antd');
|
||||
var Datepicker = antd.Datepicker;
|
||||
|
||||
import { Datepicker } from 'antd';
|
||||
React.render(<Datepicker />, mountNode);
|
||||
```
|
||||
|
||||
@ -35,31 +31,10 @@ React.render(<Datepicker />, mountNode);
|
||||
- [React modules](http://react-component.github.io/)
|
||||
- [React style guide](https://github.com/react-component/react-component.github.io/blob/master/docs/en-US/component-code-style.md)
|
||||
- [React component design guide](https://github.com/react-component/react-component.github.io/blob/master/docs/en-US/component-design.md)
|
||||
- [Developer Instruction](https://github.com/ant-design/ant-design/wiki/%E7%BD%91%E7%AB%99%E5%92%8C%E7%BB%84%E4%BB%B6%E5%BC%80%E5%8F%91%E8%AF%B4%E6%98%8E)
|
||||
- [Versioning Release Note](https://github.com/ant-design/ant-design/wiki/%E7%89%88%E6%9C%AC%E5%8F%91%E5%B8%83%E6%B5%81%E7%A8%8B)
|
||||
|
||||
|
||||
## Contributing
|
||||
|
||||
We welcome all contributions, please submit any ideas as [pull requests](https://github.com/ant-design/ant-design/pulls) or as a [GitHub issue](https://github.com/ant-design/ant-design/issues).
|
||||
|
||||
|
||||
## Development
|
||||
|
||||
#### Building locally
|
||||
|
||||
```bash
|
||||
$ npm start
|
||||
```
|
||||
|
||||
Then open `http://127.0.0.1:8000`.
|
||||
|
||||
#### [Website](http://ant.design) deployment
|
||||
|
||||
```bash
|
||||
$ npm run deploy
|
||||
```
|
||||
|
||||
#### Creating a release build
|
||||
|
||||
```bash
|
||||
$ npm run release
|
||||
```
|
||||
|
@ -11,7 +11,7 @@
|
||||
## 特性
|
||||
|
||||
- 提炼自企业级后台产品的交互语言和视觉风格。
|
||||
- 丰富实用的 React UI 组件。
|
||||
- [React Component](http://react-component.github.io/badgeboard/) 基础上二次封装的丰富实用的 UI 组件。
|
||||
- 基于 React 的组件化开发模式。
|
||||
- 背靠 npm 生态圈。
|
||||
- 基于 webpack 的调试构建方案,支持 ES6。
|
||||
@ -20,9 +20,7 @@
|
||||
## 示例
|
||||
|
||||
```jsx
|
||||
var antd = require('antd');
|
||||
var Datepicker = antd.Datepicker;
|
||||
|
||||
import { Datepicker } from 'antd';
|
||||
React.render(<Datepicker />, mountNode);
|
||||
```
|
||||
|
||||
|
@ -36,9 +36,7 @@
|
||||
## 示例
|
||||
|
||||
```jsx
|
||||
var antd = require('antd');
|
||||
var Datepicker = antd.Datepicker;
|
||||
|
||||
import { Datepicker } from 'antd';
|
||||
React.render(<Datepicker />, mountNode);
|
||||
```
|
||||
|
||||
|
@ -9,7 +9,7 @@ Ant Design 是一个 UI 设计语言,是一套提炼和应用于企业级后
|
||||
|
||||
<img width="360" src="https://t.alipayobjects.com/images/rmsweb/T1B9hfXcdvXXXXXXXX.svg">
|
||||
|
||||
Ant Design 源自蚂蚁金服体验技术部的后台产品开发,我们的设计师和前端工程师经过大量的项目实践和总结,希望能抽象出一套企业级的交互视觉规范,统一后台项目的前端 UI 设计,屏蔽各种不必要的设计差异和前端实现成本,解放设计和开发资源,服务更多产品。
|
||||
Ant Design 源自蚂蚁金服体验技术部的后台产品开发,我们的设计师和前端工程师经过大量的项目实践和总结,希望能抽象出一套企业级的交互视觉规范,统一后台项目的前端 UI 设计,屏蔽各种不必要的设计差异和前端实现成本,解放设计和前端开发资源。
|
||||
|
||||
整套设计规范还在持续整理和完善中。
|
||||
|
||||
@ -21,7 +21,7 @@ Ant Design 源自蚂蚁金服体验技术部的后台产品开发,我们的设
|
||||
|
||||
我们采用 [React](http://facebook.github.io/react/) 封装了一套 Ant Design 的组件库。
|
||||
|
||||
- [React](/docs/introduce)
|
||||
- [Ant Design of React](/docs/introduce)
|
||||
|
||||
## 如何贡献
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user