Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cookiey/guide
next Yearning doc
https://github.com/cookiey/guide
Last synced: about 2 months ago
JSON representation
next Yearning doc
- Host: GitHub
- URL: https://github.com/cookiey/guide
- Owner: cookieY
- Created: 2022-05-06T09:55:04.000Z (over 2 years ago)
- Default Branch: next
- Last Pushed: 2024-11-05T02:03:57.000Z (about 2 months ago)
- Last Synced: 2024-11-05T11:23:47.282Z (about 2 months ago)
- Size: 15 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# yearning-guide
The Site is generated using [vuepress](https://vuepress.vuejs.org/) and [vuepress-theme-plume](https://github.com/pengzhanbo/vuepress-theme-plume)
## Install
```sh
pnpm i
```
## Usage
```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
```
## 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://.github.io/`, you can skip this step as `base` defaults to `"/"`.
- If you are planning to deploy to `https://.github.io//`, meaning your repository URL is `https://github.com//`, set `base` to `"//"`.
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)
## Documents
- [vuepress](https://vuepress.vuejs.org/)
- [vuepress-theme-plume](https://theme-plume.vuejs.press/)