GitHub Pages Deployment
This repository includes a Pages workflow at .github/workflows/docs-pages.yml.
Deployment model
- trigger: push to
main(and manual dispatch) - build engine: HonKit (
npx honkit build docs docs-site) - publish target: GitHub Pages artifact from
docs-site/
One-time repository setup
- Open repository settings in GitHub.
- Go to Pages.
- Under Build and deployment, set source to GitHub Actions.
After setup, every push to main rebuilds and deploys the docs site.
Local preview before push
npx honkit build docs docs-site
npx honkit serve docs