📝 docs: 更新文档

docs/components/index.md

@@ -0,0 +1,7 @@
+---
+title: 说明
+order: 1
+nav:
+  title: 组件库
+  order: 2
+---

docs/guide/index.md

@@ -0,0 +1,18 @@
+---
+title: 说明
+nav:
+  title: 指南
+  order: 1
+---
+
+# 说明
+
+该仓库是我自行积累的设计组件库
+
+## 为什么会有这个?
+
+- 做过的设计挺多, 但是缺少总结
+- 业务组件如果可以沉淀,那么未来可以给自己复用
+- 终身计划的一环
+
+首要目的不是给外部使用,而是作为我个人设计资源的整理

docs/index.md

@@ -1,23 +1,67 @@
-# 说明
+---
+title: 空谷的组件库
+hero:
+  title: 空谷的组件库
+  desc: 🌈 九土之台 起于累土
+  actions:
+    - text: 说明
+      link: /guide
+    - text: 组件库
+      link: /components
 
-该仓库是我自行积累的设计组件库
+features:
+  - icon: https://gw.alipayobjects.com/os/q/cms/images/k9ziitmp/13668549-b393-42a2-97c3-a6365ba87ac2_w96_h96.png
+    title: 简单易用
+    desc: 在 Ant Design 上进行了自己的封装，更加易用
+  - icon: https://gw.alipayobjects.com/os/q/cms/images/k9ziik0f/487a2685-8f68-4c34-824f-e34c171d0dfd_w96_h96.png
+    title: Ant Design
+    desc: 与 Ant Design 设计体系一脉相承，无缝对接 antd 项目
+  - icon: https://gw.alipayobjects.com/os/q/cms/images/k9zij2bh/67f75d56-0d62-47d6-a8a5-dbd0cb79a401_w96_h96.png
+    title: TypeScript
+    desc: 使用 TypeScript 开发，提供完整的类型定义文件
 
-## 为什么会有这个?
+footer: Open-source MIT Licensed | Copyright © 2021-present
+---
 
-- 做过的设计挺多, 但是缺少总结
-- 业务组件如果可以沉淀,那么未来可以给自己复用
-- 终身计划的一环
+[![Coverage][coverage]][codecov-url] [![Gitmoji][gitmoji]][gitmoji-url] [![semantic-release][semantic-release]][semantic-release-repo] ![][license-url]
 
-首要目的不是给外部使用,而是作为我个人设计资源的整理
+[![ docs by dumi][dumi-url]](https://d.umijs.org/) [![Build With father][father-url]](https://github.com/umijs/father/) [![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)][lerna-url] [![typedoc](https://img.shields.io/badge/API%20by-typedoc-9600ff.svg)](https://typedoc.org/)
+
+<!-- umi url -->
+
+[lerna-url]: https://lernajs.io/
+[dumi-url]: https://img.shields.io/badge/docs%20by-dumi-blue
+[father-url]: https://img.shields.io/badge/build%20with-father-028fe4.svg
+
+<!-- badage url -->
+
+[gitmoji]: https://img.shields.io/badge/Gitmoji-%20😜%20😍-FFDD67.svg
+[gitmoji-url]: https://gitmoji.carloscuesta.me/
+[semantic-release]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
+[semantic-release-repo]: https://github.com/semantic-release/semantic-release
+[license-url]: https://img.shields.io/github/license/arvinxx/gitmoji-commit-workflow
+
+<!-- Github CI -->
+
+[test-ci]: https://github.com/arvinxx/components/workflows/Test%20CI/badge.svg
+[release-ci]: https://github.com/arvinxx/components/workflows/Release%20CI/badge.svg
+[test-ci-url]: https://github.com/arvinxx/components/actions?query=workflow%3A%22Test+CI%22
+[deploy-ci-url]: https://github.com/arvinxx/components/actions?query=workflow%3A%22Release+CI%22
+[coverage]: https://codecov.io/gh/arvinxx/components/branch/master/graph/badge.svg
+[codecov-url]: https://codecov.io/gh/arvinxx/components/branch/master
 
 ## 组件看板
 
-| 组件                                     | 版本                                                                             | 说明                                   |
-| ---------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------- |
-| float-label-input                        | [![NPM version][float-label-input-version-image]][float-label-input-version-url] | 标签会跟随 hover 状态浮动的 Input 组件 |
-| [page-loading](/components/page-loading) | [![NPM version][page-loading-version-image]][page-loading-version-url]           | 加载状态组件                           |
+| 组件                                    | 版本                                                                             | 说明                                   |
+| --------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------- |
+| float-label-input                       | [![NPM version][float-label-input-version-image]][float-label-input-version-url] | 标签会跟随 hover 状态浮动的 Input 组件 |
+| [PageLoading](/components/page-loading) | [![NPM version][page-loading-version-image]][page-loading-version-url]           | 加载状态组件                           |
 
 [float-label-input-version-image]: http://img.shields.io/npm/v/@arvinxu/float-label-input.svg?color=deepgreen&label=latest
 [float-label-input-version-url]: http://npmjs.org/package/@arvinxu/float-label-input
 [page-loading-version-image]: http://img.shields.io/npm/v/@arvinxu/page-loading.svg?color=deepgreen&label=latest
 [page-loading-version-url]: http://npmjs.org/package/@arvinxu/page-loading
+
+## 协议
+
+MIT ® Arvin Xu

packages/page-loading/src/index.tsx

@@ -34,7 +34,7 @@ export interface PageLoadingProps {
   backgroundColor?: string;
 
   /**
-   * 该组件的 id
+   * 进度条 id。如果存在多个 PageLoading 组件，需要指定 id 以区分进度条
    */
   id?: string;
 }