构建说明

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说明

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

用法

  • 在一栏目下新建ps1脚本文件,填写一下内容保存
  1. . ../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配置,找到并生成所有栏目
  • 覆盖原则同上