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.
Local preview
Section titled “Local preview”cd websitenpm installnpm run devWhere things live
Section titled “Where things live”| Path | Purpose |
|---|---|
website/content/docs/ | Starlight docs pages |
website/styles/custom.css | Shared docs theme overrides |
website/astro.config.mjs | Starlight sidebar and site config |
website/pages/ | Landing pages and other Astro routes |
Adding a page
Section titled “Adding a page”- Create a new
.mdfile underwebsite/content/docs/... - Add frontmatter with a title and description
- Link it in
website/astro.config.mjsif you want it in the sidebar - Use Starlight features like code block titles, tables, and admonitions to make the page easier to scan
Styling tips
Section titled “Styling tips”- 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:::warningfor different styles. Here is an example of a tip:
:::tip[Tip]This is a helpful tip to keep in mind.:::