Grimmory Docs

Documentation for Grimmory, built with Astro and Starlight. Live at grimmory.org.

Development

Requires Node 22.12+ and Git LFS.

npm ci
npm run dev

npm run build     # production build to dist/
npm run preview   # serve the production build locally

Content

Pages are MDX in src/content/docs/. Screenshot assets live in src/assets/images/ and render through the DocsImage component. For theme-aware screenshots, place light.png and dark.png in a folder and reference that folder with the /img/ path:

<DocsImage src={"/img/dashboard/dashboard-overview"} alt={"Dashboard"} />

A single image file at the path works too. Browser-served static assets, such as the site favicon, live in public/.

Screenshots are captured by the automation in the grimmory-seed repo and copied here with grimmory-seed sync. Images that automation can't capture (external UIs, e-reader hardware) carry a manual attribute on their DocsImage tag so sync doesn't report them as gaps.

Deploy

Pushes to main deploy to GitHub Pages via deploy.yml. The custom domain is set in public/CNAME and site in astro.config.mjs.