Documentation that stays simple

Write Markdown, push to GitHub, and publish a fast static documentation site.

What this starter gives you

Markdown-first authoring with optional MDX when you need richer content.
File-based navigation powered by Starlight.
Built-in search, syntax highlighting, responsive navigation, and dark mode.
Static output with no backend runtime.
Automatic GitHub Pages deployment from the main branch.
A small, opinionated structure that is easy for humans and coding agents to maintain.

Write documentation

Create a Markdown file anywhere under src/content/docs/:

src/content/docs/
├── index.md
├── getting-started.md
├── guides/
│   └── writing-content.md
└── reference/
    └── project-structure.md

Each Markdown page needs a title in frontmatter:

---
title: Authentication
---

# Authentication

Document the feature here.

Publish

Push the repository to GitHub, choose GitHub Actions as the Pages source once, then push changes to main. The included workflow builds and deploys the site automatically.

Continue with Getting started.