- todo
git clone https://github.com/MrHanson/vuepress-template.git
cd vuepress-template
npm i
# or
yarn
docs 目录下为 vuepress 文档的所有相关代码
-
README.md为网站首页
-
home.md为目录页
-
guide和demo文件夹为默认的两个模块(可根据需求自行更改),文件夹内为对应模块的文章
- 启动本地服务
npm run docs:dev
# or
yarn docs:dev
- 在对应模块的文件夹内创建 markdown 文件并写作
- 构建文档
npm run docs:build
# or
yarn docs:build
- 执行模板已经配置好相关的 npm script
# 执行如下指令其一即可
npm run docs:deploy
# or
yarn docs:deploy
- 将该仓库的的 github pages 设置为 gh-pages 分支