网站使用 vuepress 和 vuepress-theme-plume 构建生成。

npm i

# 启动开发服务 npm run docs:dev # 构建生产包 npm run docs:build # 本地预览生产服务 npm run docs:preview # 更新 vuepress 和主题 npm run vp-update

主题已创建 github actions: .github/workflows/docs-deploy.yml，你还需要在 github 仓库中进行以下设置：

• settings > Actions > General，拉到页面底部，在 Workflow permissions 下，勾选 Read and write permissions，并点击保存按钮

• settings > Pages, 在 Build and deployment 中，Source 选择 Deploy from a branch, Branch 选择 gh-pages，并点击保存按钮 (首次创建可能没有 gh-pages分支，你可以先完成上面的设置后，推送一次代码到主分支，等待 github actions 完成后再进行设置)

• 修改 docs/.vuepress/config.ts 中的 base 选项：

  • 如果你准备发布到 https://<USERNAME>.github.io/ ，你可以省略这一步，因为 base 默认就是 "/" 。
  • 如果你准备发布到 https://<USERNAME>.github.io/<REPO>/ ，也就是说你的仓库地址是 https://github.com/<USERNAME>/<REPO> ，则将 base 设置为 "/<REPO>/"。

如需要自定义域名，请查看 Github Pages 文档

• vuepress
• vuepress-theme-plume