Skip to content

Commit fec5959

Browse files
committed
更新构建说明
1 parent d15439e commit fec5959

File tree

3 files changed

+16
-6
lines changed

3 files changed

+16
-6
lines changed

.gitignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ target/
2929
*.log
3030
*.tmp
3131
*.vsprops
32-
*.suo
32+
*.suo
3333
*.user
3434
*.userprefs
3535
*.sdf
@@ -49,3 +49,4 @@ vuepress
4949
yarn.lock
5050
temp.ps1
5151
*-temp*
52+
articles/.vuepress/sidebar.json

articles/.vuepress/sidebar.json

+1
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@
7979
"Model.md",
8080
"Normal.md",
8181
"Search.md",
82+
"从零开始的最佳实践.md",
8283
"入门.md"
8384
]
8485
}]

build/readme.md

+13-5
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,21 @@
88
- `vuepress dev`运行项目
99
- `vuepress build`发布项目
1010

11-
## build-toc.ps1
11+
### 注意事项
1212

13-
### build-toc.ps1说明
13+
- 每个文件夹下需要有个`README.md`文件,会生成`index.html`,没有的话导航到该目录就无内容
14+
15+
## 生成api文档
16+
17+
- 暂时没用到
18+
19+
### build-toc.ps1
20+
21+
#### build-toc.ps1说明
1422

1523
- 根据文件夹结构生成一个栏目下的目录
1624

17-
### 用法
25+
#### 用法
1826

1927
- 在一栏目下新建`ps1`脚本文件,填写一下内容保存
2028

@@ -26,9 +34,9 @@
2634
- 运行之后该目录会生成一个`toc-temp.md`目录文件,如果不存在`toc.md`,则自动创建一个
2735
- 第二次运行只会生成新的`toc-temp.md`,不会覆盖`toc.md`,这样当`toc.md`内容调整时,可以从`toc-temp.md`复制新的目录内容到`toc.md`进行手工调整
2836

29-
## build.ps1
37+
### build.ps1
3038

31-
### build.ps1说明
39+
#### build.ps1说明
3240

3341
- 根据配置文件的`build`-`content`配置,找到并生成所有栏目
3442
- 覆盖原则同上

0 commit comments

Comments
 (0)