-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
光弘
committed
May 23, 2018
1 parent
931b926
commit 9a44d67
Showing
11 changed files
with
178 additions
and
314 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
const fs = require('fs'); | ||
|
||
fs.copyFileSync('./node_modules/uxcore/README_CN.md', './site/start/base/index.md'); | ||
|
||
const startMdPath = './node_modules/uxcore/README_CN.md'; | ||
let startMd = fs.readFileSync(startMdPath, 'utf-8'); | ||
startMd = startMd.replace('中文 | [English](./README.md)', ''); | ||
startMd = ` | ||
- order: 0 | ||
- category: START | ||
- chinese: 开始使用 | ||
--- | ||
${startMd}`; | ||
|
||
fs.writeFileSync('./site/start/base/index.md', startMd); | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,113 +1,86 @@ | ||
|
||
- order: 0 | ||
- category: START | ||
- chinese: 开始使用 | ||
|
||
--- | ||
|
||
|
||
# [UXCore](http://uxco.re/) | ||
|
||
[](https://www.npmjs.com/package/uxcore) [](https://david-dm.org/uxcore/uxcore) [](https://david-dm.org/uxcore/uxcore#info=devDependencies) | ||
|
||
UXCore is a set of [React](http://facebook.github.io/react/) Components that is designed for enterprise-class pc backend application. | ||
|
||
* **Rich library:** more than 35 React Components available with high quality design. | ||
|
||
* **Focus on backend App:** Powerful but easy-to-use Form and Table. | ||
|
||
* **Customizable theme:** theme can be customized easily. | ||
* **丰富的组件功能:** 超过 50 个高质量组件供使用 | ||
|
||
Before posting an issue, please read the [CHANGELOG](https://github.com/uxcore/uxcore/releases) and the README and the documentation to check the recently updated. | ||
* **专注于企业级中后台应用场景:** 强大易用的表单表格 | ||
|
||
## For inner staff | ||
* **精心设计的视觉风格:** 深耕中后台场景,让工作变得简单幸福。 | ||
|
||
please see http://groups.alidemo.cn/uxcore/doc/ for details. | ||
集团内部请查看 http://groups.alidemo.cn/uxcore/doc/ 了解详情。 | ||
|
||
## CodePen | ||
点击 [文档站点](http://uxco.re/) 获取动态演示例子。 | ||
|
||
The easiest way to start hacking on UXCore is using the following CodePen Demo: | ||
在提 issue 之前, 请阅读 [更新日志](https://github.com/uxcore/uxcore/releases) 获取最新的功能更新。 | ||
|
||
* **[UXCore Demo](http://codepen.io/eternalsky/pen/qZwNVL)** | ||
|
||
## [Starter kit](https://github.com/uxcore/starter-kit) | ||
## 安装 | ||
|
||
If you're just getting started, you can download the starter kit. The starter kit is initialized by [NOWA](http://nowa-webpack.github.io/web/index.html?en) which is our project-level development and production solution collections. | ||
|
||
<a style="height: 48px;line-height: 48px;font-size:24px;text-align:center;width: 300px;background: #2599f2;color: white;display:block;border-radius: 5px;margin: 20px auto;text-decoration:none;" href="https://github.com/uxcore/starter-kit/archive/master.zip" target="_blank">Download Starter Kit</a> | ||
```sh | ||
npm install uxcore --save | ||
``` | ||
|
||
## Installation | ||
## 使用 | ||
|
||
The fastest way to get started is to serve JavaScript from the CDN | ||
### 引入 js | ||
|
||
```html | ||
<link rel="stylesheet" type="text/css" href="//g.alicdn.com/??platform/common/s/1.1/global/global.css,uxcore/uxcore/0.19.25/orange.min.css"> | ||
<script src="//g.alicdn.com/uxcore/uxcore/0.19.25/uxcore.min.js"> | ||
```jsx | ||
import { Button } from 'uxcore'; | ||
ReactDOM.render(<Button />, mountNode); | ||
``` | ||
|
||
if you'd like to use [npm](npmjs.com) | ||
### 按需引入 js | ||
|
||
```sh | ||
npm install uxcore | ||
``` | ||
* 使用 [babel-plugin-import](https://github.com/ant-design/babel-plugin-import) (推荐) | ||
|
||
## Usage | ||
```js | ||
// .babelrc or babel-loader option | ||
{ | ||
"plugins": [ | ||
["import", { libraryName: "uxcore", camel2DashComponentName: false }] | ||
] | ||
} | ||
``` | ||
|
||
### For cdn | ||
|
||
```jsx | ||
const {Button} = Uxcore; | ||
ReactDOM.render(<Button />, mountNode); | ||
``` | ||
* 或者,手动引入 | ||
|
||
### For npm | ||
```jsx | ||
import {Button} from 'uxcore'; | ||
// or | ||
import Button from 'uxcore/lib/Button'; | ||
ReactDOM.render(<Button />, mountNode); | ||
``` | ||
```js | ||
import Button from 'uxcore/lib/Button'; | ||
``` | ||
|
||
And import style mannally | ||
### 引入样式包 | ||
|
||
```less | ||
@import '~uxcore/assets/iconfont.css'; | ||
@import '~uxcore/assets/orange.css'; | ||
``` | ||
|
||
### import component as required | ||
|
||
Install the component | ||
```sh | ||
npm install uxcore-button kuma-base | ||
``` | ||
## 浏览器支持 | ||
|
||
```jsx | ||
import Button from 'uxcore-button'; | ||
``` | ||
And import style in your less file | ||
```less | ||
@import '~kuma-base/theme/blue.less'; // or orange.less global variables which components need | ||
@import '~kuma-base/core.less'; // base element style and reset | ||
@import '~uxcore-button/src/Button.less'; // component style | ||
``` | ||
主流浏览器及 IE9+ | ||
|
||
## 项目共建 | ||
|
||
## Browser Support | ||
我们非常欢迎您一起将 uxcore 做的更好! 查看 [CONTRIBUTING 文档](https://github.com/uxcore/uxcore/blob/master/CONTRIBUTING.md) 获取详细信息。 | ||
|
||
Mainstream browsers and Internet Explorer 8+. For IE 8, see [react-ie8](https://github.com/xcatliu/react-ie8) to get support. | ||
## 许可 | ||
|
||
## Customization | ||
本项目基于 [MIT 协议](https://github.com/uxcore/uxcore/blob/master/LICENSE) 进行开发和发布 | ||
|
||
We have implemented two default themes(orange/blue) to render UXCore Components. Theme customization is simple using our online [design tools](http://uxco.re/theme/builder). | ||
|
||
## Contribute | ||
|
||
Yes please! See the [CONTRIBUTING](https://github.com/uxcore/uxcore/blob/master/CONTRIBUTING.md) for details. | ||
|
||
## License | ||
|
||
This project is licensed under the terms of the [MIT license](This project is licensed under the terms of the MIT license) | ||
|
Oops, something went wrong.