Skip to content
Project Name
HomeToolsDocs

Getting Started

Scaffold the project locally and explore the key pieces of the template.

Install the dependencies

Section titled “Install the dependencies”
Terminal window
npm install

Use bun install or pnpm install if you prefer a different package manager. After everything is installed, boot the local dev server.

Terminal window
npm run dev

The docs will be available at http://localhost:4321. Any time you edit Markdown or components the page reloads automatically.

Understand the layout

Section titled “Understand the layout”

This template uses the default Starlight content collection. All documentation lives under src/content/docs/. Each Markdown or MDX file maps to a route using its file name. The sidebar is controlled by the sidebar array in astro.config.mjs.

.
├── src/
│   ├── assets/              # Logos and homepage artwork
│   ├── components/          # Custom landing page component
│   ├── content/             # Markdown content grouped by collection
│   └── styles/              # Global CSS overrides
└── public/                  # Favicons and share images

The default landing page (/) renders src/components/Lander.astro. The rest of the documentation pages use Starlight’s standard layouts.

Development tips

Section titled “Development tips”
  • Keep docs short and task-oriented. Split long guides into multiple files and link between them.
  • Use MDX when you need interactive examples or component embeds. Everything in src/components/ becomes available to your MDX files.
  • Run npm run build periodically to make sure the project compiles without warnings.