Index

Overview

Documentation pages are written in Markdown and live in the content/docs/ directory. Each file becomes a page on the site — the file path maps directly to the URL.

Front Matter

Every page must start with a frontmatter block between --- delimiters.

---
title: My Page Title
description: A short summary shown in search results and meta tags
navOrder: 1
---

Headings

Start your content headings at h2 (##). The page title from frontmatter is rendered as the h1 automatically — adding your own h1 in the body will not appear in the table of contents.

## Section Title

### Subsection

#### Deeper nesting (not shown in TOC)

The table of contents on the right side of the page is built automatically from ## and ### headings.

Text Formatting

**bold text**

_italic text_

~~strikethrough~~

`inline code`

[link text](https://example.com)

[internal link](/docs/getting-started)

Code Blocks

Wrap code in triple backticks and specify the language for syntax highlighting.

```ts
export function greet(name: string) {
  return `Hello, ${name}`
}
```

Supported languages include ts, js, vue, bash, json, yaml, css, html, markdown, and many more.

Callouts / Alerts

Use blockquotes with a bold label for callouts:

> **Note**
> Something worth knowing but not critical.

> **Warning**
> This could cause problems if ignored.

> **Tip**
> A helpful suggestion.

Tables

| Column A | Column B | Column C |
|----------|----------|----------|
| value    | value    | value    |
| value    | value    | value    |

Alignment is optional:

| Left | Center | Right |
|:-----|:------:|------:|
| text | text   | text  |

Images

Place images in the public/ directory and reference them with an absolute path:

![Alt text](/images/screenshot.png)

Always provide meaningful alt text for accessibility.

Organising Pages into Groups

The left sidebar groups pages by their folder. To set a group's title and sort order, add a _dir.yml file inside the folder:

# content/docs/guides/_dir.yml
title: Guides
navOrder: 3

Pages within that folder are then sorted by their own navOrder frontmatter.

Example structure

content/
└── docs/
    ├── getting-started.md   # navOrder: 1
    ├── writing-content.md   # navOrder: 2
    ├── guides/
    │   ├── _dir.yml         # title: Guides, navOrder: 3
    │   ├── installation.md  # navOrder: 1
    │   └── configuration.md # navOrder: 2
    └── reference/
        ├── _dir.yml         # title: Reference, navOrder: 4
        └── api.md           # navOrder: 1

Checklist Before Publishing

• Frontmatter has title, description, and navOrder
• No # h1 heading in the body — the title comes from frontmatter
• All headings start at ##
• Code blocks have a language specified
• Images have alt text
• Internal links use paths starting with /docs/