Repository files
A sample reference page: one table, scannable, nothing else. Most projects end up with a few of these — configuration options, CLI flags, error codes.
| Path | What it is | Change it? |
|---|---|---|
astro.config.mjs |
Site title, sidebar, edit link, social links. | Yes — first. |
src/content/docs/ |
Every page of the site, one file each. | Yes — this is the content. |
src/content/docs/index.mdx |
The home page. | Yes. |
src/styles/custom.css |
The accent colour, as one hue number. | If you want another colour. |
src/components/Footer.astro |
Adds the “Deployed on One9x Pages” line under each page. | Delete it to remove the line. |
src/assets/ |
Images used in pages. Optimised at build time. | Add yours. |
public/ |
Copied to the site unchanged. Holds the favicon. | Replace the favicon. |
.github/workflows/deploy.yml |
Builds and deploys on every push and pull request. | Rarely. |
AGENTS.md |
How an AI coding agent should build and deploy this repo. | Rarely. |
src/content.config.ts |
Tells Astro the pages are Starlight docs. | No. |
CI settings
Section titled “CI settings”Under Settings → Secrets and variables → Actions in the repository:
| Name | Kind | Required | Value |
|---|---|---|---|
ONE9X_SITE |
Variable | Yes | The site to deploy to, e.g. mydocs. Until it is set the deploy job is skipped. |
ONE9X_TOKEN |
Secret | Yes | A token from one9x tokens create "github actions". |
SITE_URL |
Variable | No | Your custom domain, e.g. https://docs.example.com. Defaults to https://<ONE9X_SITE>.one9x.app. |
Commands
Section titled “Commands”| Command | What it does |
|---|---|
npm install |
Installs dependencies. |
npm run dev |
Serves the site at localhost:4321, reloading on every change. |
npm run build |
Writes the finished site, search index included, to dist/. |
npm run preview |
Serves dist/ locally, to check a build before you push. |
Deployed on One9x Pages