mirror of
https://github.com/pengzhanbo/vuepress-theme-plume.git
synced 2026-04-23 10:58:13 +08:00
75 lines
2.3 KiB
Handlebars
75 lines
2.3 KiB
Handlebars
# {{ name }}
|
|
|
|
The Site is generated using [vuepress](https://vuepress.vuejs.org/) and [vuepress-theme-plume](https://github.com/pengzhanbo/vuepress-theme-plume)
|
|
|
|
## Install
|
|
|
|
```sh
|
|
{{#if (equal packageManager "pnpm")}}
|
|
pnpm i
|
|
{{else if (equal packageManager "yarn")}}
|
|
yarn
|
|
{{else}}
|
|
npm i
|
|
{{/if}}
|
|
```
|
|
|
|
## Usage
|
|
|
|
{{#if (equal packageManager "pnpm")}}
|
|
```sh
|
|
# 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
|
|
```
|
|
{{else if (equal packageManager "yarn")}}
|
|
```sh
|
|
# start dev server
|
|
yarn docs:dev
|
|
# build for production
|
|
yarn docs:build
|
|
# preview production build in local
|
|
yarn docs:preview
|
|
# update vuepress and theme
|
|
yarn vp-update
|
|
```
|
|
{{else}}
|
|
```sh
|
|
# start dev server
|
|
npm run docs:dev
|
|
# build for production
|
|
npm run docs:build
|
|
# preview production build in local
|
|
npm run docs:preview
|
|
# update vuepress and theme
|
|
npm run vp-update
|
|
```
|
|
{{/if}}
|
|
|
|
{{#if (equal deploy "github")}}
|
|
## Deploy to GitHub Pages
|
|
|
|
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, under `Workflow permissions`, check `Read and write permissions`, and click the save button.
|
|
|
|
- [ ] `settings > Pages`, In `Build and deployment`, select `Deploy from a branch` for `Source`, choose `gh-pages` for `Branch`, and click the save button.
|
|
(The `gh-pages` branch may not exist upon first creation. You can complete the above setup first, push the code to the main branch, wait for `github actions` to finish, and then proceed with the setup.)
|
|
|
|
- [ ] Modify the `base` option in `docs/.vuepress/config.ts`:
|
|
- If you are planning to deploy to `https://<USERNAME>.github.io/`, you can skip this step as `base` defaults to `"/"`.
|
|
- If you are planning to deploy to `https://<USERNAME>.github.io/<REPO>/`, meaning your repository URL is `https://github.com/<USERNAME>/<REPO>`, set `base` to `"/<REPO>/"`.
|
|
|
|
To customize a domain name, please refer to [Github Pages](https://docs.github.com/zh/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages)
|
|
|
|
{{/if}}
|
|
## Documents
|
|
|
|
- [vuepress](https://vuepress.vuejs.org/)
|
|
- [vuepress-theme-plume](https://theme-plume.vuejs.press/)
|