Adding Documentation

Creating New Pages

Create Markdown files in src/content/docs/. The file path becomes the URL:

File Path	URL
src/content/docs/guides/setup.md	/guides/setup
src/content/docs/reference/api.md	/reference/api
src/content/docs/tutorials/basics.md	/tutorials/basics

Page Structure

Every page requires frontmatter:

---
title: Your Page Title
description: Brief description for SEO and previews
---

# Your Content Here

Write standard Markdown content.

Frontmatter Options

---
title: Required Page Title
description: Optional but recommended
sidebar:
  order: 1           # Control sort order in sidebar
  label: Custom Name # Override title in sidebar
  badge: New         # Add a badge
tableOfContents: true # Show/hide ToC (default: true)
---

Adding New Sections

1. Create a new directory in src/content/docs/
2. Add it to sidebar in astro.config.mjs:

sidebar: [
  {
    label: 'New Section',
    autogenerate: { directory: 'new-section' },
  },
],

Supported Content

• Standard Markdown
• GitHub Flavored Markdown (tables, task lists)
• Code blocks with syntax highlighting
• Mermaid diagrams (if configured)
• MDX components

Deploy Changes

npm run build && npm run deploy

Or simply:

npm run deploy