构建说明
vuepress生成文档
- build-sidebar.ps1在文件管理打开,右键选中,选择
使用PowerShell
运行 - 生成vuepress所需侧边栏菜单,输出到
/articles/.vuepress/sidebar.json
- vuepress根据
sidebar.json
生成侧边栏菜单 vuepress dev
运行项目vuepress build
发布项目
注意事项
- 每个文件夹下需要有个
README.md
文件,会生成index.html
,没有的话导航到该目录就无内容 - 之前的readme文件有大写开头、全小写、全大写的,后面统一改成大写后需要设置
git config core.ignorecase false
大小写敏感,否则修改了旧的readme可能提交不了
生成api文档
build-toc.ps1
build-toc.ps1说明
用法
. ../build/build-toc.ps1 $PSScriptRoot
- 选中该脚本,点击右键选择
使用PowerShell
运行 - 运行之后该目录会生成一个
toc-temp.md
目录文件,如果不存在toc.md
,则自动创建一个 - 第二次运行只会生成新的
toc-temp.md
,不会覆盖toc.md
,这样当toc.md
内容调整时,可以从toc-temp.md
复制新的目录内容到toc.md
进行手工调整
build.ps1
build.ps1说明
- 根据配置文件的
build
-content
配置,找到并生成所有栏目 - 覆盖原则同上