The Site is generated using vuepress and vuepress-theme-plume
pnpm i
# start dev server
pnpm docs:dev
# build for production
pnpm docs:build
# preview production build in local
pnpm docs:preview
# update vuepress and theme
pnpm vp-update
The plume theme has been created with GitHub Actions: .github/workflows/docs-deploy.yml
. You also need to make the following settings in the GitHub repository:
-
settings > Actions > General
, Scroll to the bottom of the page, underWorkflow permissions
, checkRead and write permissions
, and click the save button. -
settings > Pages
, InBuild and deployment
, selectDeploy from a branch
forSource
, choosegh-pages
forBranch
, and click the save button. (Thegh-pages
branch may not exist upon first creation. You can complete the above setup first, push the code to the main branch, wait forgithub actions
to finish, and then proceed with the setup.) -
Modify the
base
option indocs/.vuepress/config.ts
:- If you are planning to deploy to
https://<USERNAME>.github.io/
, you can skip this step asbase
defaults to"/"
. - If you are planning to deploy to
https://<USERNAME>.github.io/<REPO>/
, meaning your repository URL ishttps://github.com/<USERNAME>/<REPO>
, setbase
to"/<REPO>/"
.
- If you are planning to deploy to
To customize a domain name, please refer to Github Pages
# 主题提供了一个 命令行工具,帮助您构建一个基本项目。您可以通过运行以下命令,启动 安装向导。
pnpm create vuepress-theme-plume@latest