Skip to content

Commit

Permalink
doc: Update development document.
Browse files Browse the repository at this point in the history
  • Loading branch information
jaywcjlove committed Aug 3, 2021
1 parent 009ee82 commit a3a76ce
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 31 deletions.
45 changes: 17 additions & 28 deletions website/src/pages/docs/development/document/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,38 +12,27 @@

```bash
├── README.md -> packages/core/README.md
├── package.json
├── lerna.json
├── tsconfig.json
├── ....
├── example # ----> 示例
│   └── base # 基础示例
├── packages # ----> 包
│   ├── core # 基础组件
│   │   ├── README.md
│   ├── core # @uiw/react-native 基础组件
│   │   ├── package.json
│   │   ├── src
│   │   │   ├── Avatar # 组件源码以及组件文档
│   │   │   ├── ....
│   │   │   └── utils
│   │   └── tsconfig.json
│   └── docs # 可忽略,编译后的组件文档静态文件提交到 npm 提供文档版本预览
├── website # ----> 文档网站源码
│   ├── README.md
│   ├── package.json
│   ├── public
│   ├── src
│   │   ├── pages # 文档示例编写在这里
│   │   │   ├── components
│   │   │   ├── docs
│   │   │   ├── home
│   │   │   └── team
│   │   └── routes
│   │   ├── Controller.tsx
│   │   ├── history.ts
│   │   ├── menus.ts # 配置菜单
│   │   └── router.tsx # 配置菜单对应的页面
│   └── tsconfig.json
└── yarn.lock
│   │   └── src
│   │      ├── Avatar # 组件源码以及组件文档
│   │      └── ....
│   └── docs # @uiw/react-native-doc 可忽略,编译后的组件文档静态文件提交到 npm 提供文档版本预览
└── website # ----> 文档网站源码
   ├── ....
   └── src
      ├── pages # 文档示例编写在这里
      │   ├── components
      │   └── ....
      └── routes
      ├── Controller.tsx
      ├── history.ts
      ├── menus.ts # 配置菜单
      └── router.tsx # 配置菜单对应的页面
```

## 文档编辑预览
Expand Down
1 change: 0 additions & 1 deletion website/src/routes/Controller.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import React from 'react';
import { Switch, Route, Redirect } from 'react-router-dom';
import { getRouterData } from '../routes/router';
import { DefaultProps } from '../';
Expand Down
6 changes: 4 additions & 2 deletions website/src/routes/menus.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ export const componentMenus: MenuData[] = [

export const docsMenus: MenuData[] = [
{ path: '/docs/getting-started', name: '快速上手' },
{ path: '/docs/development/components', name: '参与组件开发' },
{ path: '/docs/development/document', name: '参与文档网站编辑开发' },
{ divider: true, name: "环境安装" },
{ path: '/docs/environment-setup/ios', name: 'iOS 环境安装' },
{ path: '/docs/environment-setup/android', name: 'Android(Mac) 环境安装' },
Expand All @@ -51,7 +53,7 @@ export const docsMenus: MenuData[] = [
{ path: '/docs/app-store/ios', name: '发布 iOS 应用商店' },
{ path: '/docs/app-store/android', name: '发布 Android 应用商店' },
{ divider: true, name: "其它" },
{ path: '/docs/development/document', name: '参与文档/网站编辑开发' },
{ path: '/docs/development/components', name: '参与组件开发' },
{ href: 'https://github.com/uiwjs/react-native-uiw/releases', target: '_blank', name: '更新日志' },
{ href: 'https://github.com/facebook/react', target: '_blank', name: 'React 官方文档' },
{ href: 'https://github.com/facebook/react-native', target: '_blank', name: 'React Native 官方文档' },
]

0 comments on commit a3a76ce

Please sign in to comment.