Documentation deployment

The field guide is built with VitePress and deployed to GitHub Pages by .github/workflows/docs.yml.

Preview locally

npm ci
npm run docs:dev

Build and check

npm run docs:commands
npm run docs:check
npm run docs:build
npm run docs:preview

docs:build refreshes the manifest-backed command reference and writes the static site to docs/.vitepress/dist/.

For npm package publishing and install instructions, follow the npm publishing guide.

GitHub Pages

The workflow runs on pushes to main and manual dispatch. It builds with the current repository name as the Pages base path, uploads the Pages artifact, and deploys it with actions/deploy-pages@v4. The workflow-provided GITHUB_REPOSITORY value keeps the asset paths correct after a repository rename. Set the Pages source to GitHub Actions in repository settings. GitHub Pages must be enabled for deployment creation to succeed.

The current site URL is anshkaliya18.github.io/Sherpa. A local build uses this same path unless GITHUB_REPOSITORY or VITEPRESS_BASE is set.

Search and metadata

VitePress local search indexes the generated pages. The site config supplies per-page canonical links, a sitemap hostname, Open Graph and Twitter metadata, and the custom mark.svg favicon. og.svg is the source social card. robots.txt is public and allows indexing; change it if the site becomes private or staged.