Introduction

This site is a template. It is a working documentation site built with Starlight, and it deploys itself to One9x Pages every time you push. Copy it, replace these pages with your own, and your project has docs.

What you get

• Pages from Markdown. One file in src/content/docs/ is one page.
• A sidebar generated from your folders, in the order you choose.
• Full-text search that runs in the browser. The index is built at the same time as the site, so there is no search service to run or pay for.
• Light and dark themes, a table of contents on every page, an “Edit page” link, and previous/next links.
• A deploy workflow. Pull requests get a preview URL; pushes to main go live.

How the files are laid out

.
├── .github/workflows/deploy.yml   # builds and deploys on every push
├── astro.config.mjs               # site title, sidebar, edit link
├── public/                        # copied as-is: favicon, robots.txt
└── src/
    ├── assets/                    # images used in pages
    ├── components/Footer.astro    # the "Deployed on One9x Pages" line
    ├── content/docs/              # every page of the site
    └── styles/custom.css          # the accent colour

The repository files page says what each one is for.

Next

Use this template to get your own copy deploying in a few minutes.