GitHub Pages Deployment
This project deploys docs with a dedicated GitHub Actions workflow.
Trigger
- Push to
main(when docs/workflow files change) - Manual run from Actions (
workflow_dispatch)
Build and Deploy
The workflow:
- Installs dependencies with
npm ci - Builds docs using
npm run docs:build - Uploads
site/.vitepress/distas Pages artifact - Deploys using
actions/deploy-pages
Base Path
The VitePress base is controlled by environment variable:
VITEPRESS_BASE=/${repo-name}/
This keeps the site compatible with project pages in forks.