doc: add timeline doc (#150)

* doc: edit layout * component: add steps component * edit doc clash * doc: add steps doc * component: add timeLine component * doc: add timeLine doc * doc: edit steps doc
uiwjs · Aug 6, 2021 · b5e562f · b5e562f
1 parent bfdf2a2
commit b5e562f
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 2 deletions.
diff --git a/packages/core/src/Steps/README.md b/packages/core/src/Steps/README.md
@@ -36,5 +36,5 @@ function Demo() {
 | 参数                 | 说明         | 类型    | 默认值  |
 | -------------------- | ------------ | ------- | ------- |
 | `title`           |步骤标题      | Item[] | - |
-| `desc`            | 步骤说明文字  | Number | 0 |
+| `desc`            | 步骤说明文字  | String | - |
 | `status`           | 步骤的状态，'success' 或 'error' | String  | - |
diff --git a/packages/core/src/Timeline/README.md b/packages/core/src/Timeline/README.md
@@ -6,7 +6,7 @@ Timeline 时间轴
 ### 基础示例
 
 ```jsx
-import { Steps } from '@uiw/react-native';
+import { Timeline } from '@uiw/react-native';
 
 function Demo() {
   return (

diff --git a/website/src/pages/components/timeLine/index.tsx b/website/src/pages/components/timeLine/index.tsx
@@ -0,0 +1,11 @@
+import Markdown, { importAll } from '../../../component/Markdown';
+
+export default class Page extends Markdown {
+  path="/packages/core/src/Timeline/README.md"
+  getMarkdown = async () => {
+    const md = await import('@uiw/react-native/lib/Timeline/README.md');
+    // 支持 markdown 中，相对于当前 index.tsx 相对路径引入图片资源
+    importAll((require as any).context('./', true, /\.(png|gif|jpg)$/), this.imageFiles);
+    return md.default || md;
+  }
+}
diff --git a/website/src/routes/menus.ts b/website/src/routes/menus.ts
@@ -34,6 +34,7 @@ export const componentMenus: MenuData[] = [
   { path: "/components/grid", name: "Grid 宫格" },
   { path: "/components/list", name: "List 列表" },
   { path: "/components/steps", name: "Steps 步骤条" },
+  { path: "/components/timeLine", name: "Timeline 时间轴" },
   { divider: true, name: "Feedback" },
   { path: "/components/loader", name: "Loader 加载" },
   { path: "/components/modal", name: "Modal 模态框" },

diff --git a/website/src/routes/router.tsx b/website/src/routes/router.tsx
@@ -168,4 +168,7 @@ export const getRouterData = {
   '/components/steps': {
     component: dynamicWrapper([], () => import('../pages/components/steps')),
   },
+  '/components/timeLine': {
+    component: dynamicWrapper([], () => import('../pages/components/timeLine')),
+  },
 };