This is the source for the chartplotter documentation site. It is built with Docusaurus and published to GitHub Pages at beetlebugorg.github.io/chartplotter.
Install dependencies and start a local server with live reload:
npm install
npm startGenerate the static site into build/:
npm run buildThe screenshots in static/img/ui/ are generated from the live app so they stay
in sync when the UI changes. To regenerate them, run from the repo root:
make docs-shotsThis builds the binary, starts a throwaway server against your baked chart cache,
drives the <chart-plotter> UI through its public API (so each shot frames the
same view and panels every run), and writes high-resolution PNGs back into
static/img/ui/. It needs baked charts in the cache and a Chromium install. See
scripts/docs-shots.mjs.
Pushing to main builds and deploys the site through the
.github/workflows/docs.yml workflow. You do not need to deploy by hand.