Quickstart

Set up your environment

Install dependencies

From the project root, install the required packages:

npm install

Start the dev server

Run the Astro development server:

npm run dev

Open the URL shown in your terminal (usually http://localhost:4321) to see your site.

Edit a page

Open docs/index.mdx in your editor and make a change. You'll see changes in your local preview.

Your content lives in the docs/ directory:

Path	Purpose
`docs/*.mdx`	Documentation pages written in MDX.
`docs/docs.json`	Configuration for navigation and site metadata.
`docs/images/`	Images referenced from your pages.
`src/`	Astro layouts, components, and styles you can customize.

Create an MDX file

Create a new file in the docs/ directory. For example, docs/my-page.mdx:

docs/my-page.mdx

---
title: "My page"
description: "A brief description of this page"
---

Write your content here using MDX.

Add it to navigation

Open docs/docs.json and add the page path (without the .mdx extension) to the relevant navigation group:

docs/docs.json

{
  "group": "Getting started",
  "pages": [
    "index",
    "quickstart",
    "my-page"
  ]
}

Push your changes to GitHub. If your hosting is configured to build on push, your site deploys automatically.

To build the site locally:

npm run build

The output goes to the dist/ directory.

Configure navigation, colors, and layout.

See the available components.