Skip to content

Docs Website

The website is built with Astro and the documentation is built with Starlight, allowing me to render markdown easily. It lives in the website/ directory and is deployed separately from the game itself.

Docs terminal
cd website
npm install
npm run dev
PathPurpose
website/content/docs/Starlight docs pages
website/styles/custom.cssShared docs theme overrides
website/astro.config.mjsStarlight sidebar and site config
website/pages/Landing pages and other Astro routes
  1. Create a new .md file under website/content/docs/...
  2. Add frontmatter with a title and description
  3. Link it in website/astro.config.mjs if you want it in the sidebar
  4. Use Starlight features like code block titles, tables, and admonitions to make the page easier to scan
  • Use title="..." on fenced code blocks to give commands a terminal look
  • Keep tables short and focused
  • Put the main action near the top of the page
  • Use blockquotes for tips, notes, and warnings to make them stand out. You can use :::tip, :::note, and :::warning for different styles. Here is an example of a tip:
Example tip
:::tip[Tip]
This is a helpful tip to keep in mind.
:::