All documentation in this repository is synchronized from the relevant external Noctalia repositories. This repository is used as the published documentation mirror, so pull requests and issues are disabled here. To propose a documentation change, update the corresponding source repository instead.
Use Node.js 22.23.4 or newer (required by Astro 7.4.4) and npm ci to install the dependency versions recorded in package-lock.json. To maintain current dependencies, check npm outdated, update direct dependencies to their latest stable releases, and refresh compatible transitive dependencies with npm update. Verify upgrades with npm audit, npm run build, and browser checks of navigation and search.
Satori 0.63.2 still pins vulnerable fflate 0.7.3. The scoped fflate override in package.json selects version 0.8.3 or newer to fix malformed ZIP64 archive handling; remove it once Satori no longer pins a vulnerable release. The former postcss-selector-parser override is no longer needed: the lockfile resolves patched version 7.1.7 through the upstream dependency range.
Commit and push dependency updates to this repository's main branch before deployment. The deployment and content-sync scripts reset the checkout to origin/main, discarding uncommitted changes.
All commands are run from the root of the project, from a terminal:
| Command | Action |
|---|---|
npm install |
Installs dependencies |
npm run dev |
Starts local dev server at localhost:4321 |
npm run build |
Build your production site to ./dist/ |
npm run preview |
Preview your build locally, before deploying |
npm run astro ... |
Run CLI commands like astro add, astro check |
npm run astro -- --help |
Get help using the Astro CLI |
Inside of your Astro + Starlight project, you'll see the following folders and files:
.
βββ public/
βββ src/
β βββ assets/
β βββ content/
β β βββ docs/
β βββ content.config.ts
βββ astro.config.mjs
βββ package.json
βββ tsconfig.json
Starlight looks for .md or .mdx files in the src/content/docs/ directory. Each file is exposed as a route based on its file name.
Images can be added to src/assets/ and embedded in Markdown with a relative link.
Static assets, like favicons, can be placed in the public/ directory.
Check out Starlightβs docs, read the Astro documentation, or jump into the Astro Discord server.