Skip to content

Commit b630948

Browse files
committed
doc: Update development document.
1 parent 6c4198d commit b630948

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

website/src/pages/docs/development/README.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,19 @@ yarn run start # 本地运行预览文档网站
9090

9191
添加一个新的文档,需要新增路由、菜单、添加 `README.md` 文件。
9292

93+
```bash
94+
website
95+
├── src
96+
│   ├── pages # 文档示例编写在这里
97+
│   │   ├── components
98+
│   │   ├── getting-started
99+
│   │   │   ├── README.md # 添加 README.md 文档
100+
│   │   │   └── index.tsx # 添加加载 README.md JS 文件
101+
│   └── routes
102+
│   ├── menus.ts # 配置菜单
103+
│   └── router.tsx # 配置菜单对应的页面
104+
```
105+
93106
#### `1. 菜单配置`
94107

95108
[`website/src/routes/menus.ts`](https://github.com/uiwjs/react-native-uiw/blob/4e4f55681a71b4813a5f5fe26f4b1a859bc85a7f/website/src/routes/menus.ts#L44) 中配置菜单
@@ -130,15 +143,6 @@ export const getRouterData = {
130143

131144
#### `3. 新增 Markdown 文件`
132145

133-
```bash
134-
├── pages
135-
│   ├── components
136-
│   ├── docs
137-
│   │   ├── getting-started
138-
│   │   │   ├── README.md # 添加 README.md 文档
139-
│   │   │   └── index.tsx # 添加加载 README.md JS 文件
140-
```
141-
142146
添加 `website/src/pages/docs/getting-started/README.md``website/src/pages/docs/getting-started/index.tsx`
143147

144148
```tsx
@@ -157,4 +161,11 @@ export default class Page extends Markdown {
157161
return md.default || md;
158162
}
159163
}
160-
```
164+
```
165+
166+
### `修改一个 Markdown 文件内容`
167+
168+
可直接点击文档网站底部的 `在 GitHub 上编辑此页` 按钮。
169+
170+
⇣⇣⇣⇣⇣⇣看见没有,点击下面按钮⇣⇣⇣⇣⇣⇣
171+
<!--rehype:style=background-color: #a0ffb3; padding: 12px 16px; display: inline-block;-->

0 commit comments

Comments
 (0)