diff --git a/docs/change-log.md b/docs/change-log.md index 63badd8..94880a9 100644 --- a/docs/change-log.md +++ b/docs/change-log.md @@ -2,3 +2,25 @@ title: 更新日志 order: 3 --- + +# 更新日志 + +`bicid` 遵循 [Semantic Versioning 2.0.0](https://semver.org/lang/zh-CN/) 语义化版本规范。 + +### 1.0.1 + +2020-10-17 + +- ✨ 新增 `BiciWebSocket` 组件,支持基于 HTML 5 WebSocket 的心跳检测,断线重连等 + +### 1.0.0 + +2020-10-13 + +- 🎉 1.0.0 正式版本发布,支持复杂表格,通知等基础组件 + +### 1.0.0-alpha + +2020-09-13 + +- 🎉 alpha 版本发布,协同编译,打包及功能测试 diff --git a/docs/index.md b/docs/index.md index 6687d83..1ef645e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,3 +2,74 @@ title: 介绍 order: 1 --- + +# Bici Design + +`bicid` 是基于博智云创 PC 端设计规范的 React UI 组件库,主要用于支撑博智云创大量的企业级中后台产品。 + +## ✨ 特性 + +- 🌈 提炼自博智云创大量的中后台产品的交互语言和视觉风格。 + +- 📦 开箱即用的高质量 React 组件。 + +- 🛡 基于蚂蚁金服 UI 库 Ant Design,高效稳定。 + +- ⚙️ 全链路开发和设计工具体系,可搭配脚手架工具。 + +- 🎨 内置博智设计规范中常用的属性 CSS。 + +## 兼容环境 + +- 现代浏览器和 IE11(需要 [polyfills](https://www.npmjs.com/package/react-app-polyfill))。 +- 支持服务端渲染。 + +| [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 | [iOS Safari](http://godban.github.io/browsers-support-badges/)
iOS Safari | [Samsung](http://godban.github.io/browsers-support-badges/)
Samsung | [Opera](http://godban.github.io/browsers-support-badges/)
Opera | +| --- | --- | --- | --- | --- | --- | --- | +| IE11, Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions | last 2 versions | last 2 versions | + +## 安装 + +### 推荐使用 nrm 和 nvm + +推荐使用 [nrm](https://github.com/Pana/nrm) 管理 npm 源,支持命令一键快捷查看,添加和切换源 + +```bash +# 查看所有源 +nrm ls + +# 一键切换源 +npm use taobao +``` + +推荐使用 [nvm](https://github.com/nvm-sh/nvm) 管理 Node 版本 + +```bash +# 查看可用的 Node 版本 +nvm ls + +# 一键切换 Node 版本 +nvm use 11.6.0 +``` + +### 推荐使用 npm 或 yarn 安装 + +推荐使用 npm 或 yarn 的方式进行开发,不仅可在开发环境轻松调试,也可放心地在生产环境打包部署使用,享受整个生态圈和工具链带来的诸多好处。 + +```bash +$ npm install bicid --save +``` + +```bash +$ yarn add bicid +``` + +如果你的网络环境不佳,推荐使用 [cnpm](https://github.com/cnpm/cnpm)。 + +## 示例 + +```js +import { BiciTable } from 'bicid'; + +ReactDOM.render(, mountNode); +```