Skip to content

Editing These Docs

This documentation site is a separate repo built with Astro and Starlight.

Terminal window
git clone https://github.com/MrDrElliot/LuminaEngine-site.git
cd LuminaEngine-site
npm install
npm run dev

Open the printed local URL. Pages live in src/content/docs/ as Markdown (.md) or MDX (.mdx). The sidebar is defined in astro.config.mjs.

  1. Create a .md file under src/content/docs/<section>/.
  2. Give it a title in the frontmatter.
  3. Add it to the sidebar in astro.config.mjs (or rely on autogenerate for sections that use it).

Pushing to main triggers a GitHub Actions build that publishes to GitHub Pages.