Documentation

Writing Content

How to write and organize documentation content

Writing Content

Learn how to write and organize your documentation.

Content Structure

Place your markdown files in the content directory:

content/
├── index.md              # Landing page
└── docs/
    ├── 1.getting-started/
    │   ├── 1.introduction.md
    │   └── 2.installation.md
    └── 2.components/
        └── 1.overview.md

Numbering Convention

Prefix folders and files with numbers to control the order:

  • 1.getting-started/ appears before 2.components/
  • 1.introduction.md appears before 2.installation.md

The numbers are stripped from the URL:

  • content/docs/1.getting-started/1.introduction.md → /docs/getting-started/introduction

Frontmatter

Each markdown file should have frontmatter:

---
title: Page Title
description: A brief description for SEO
---

# Content Here

Markdown Features

Headings

# H1 - Page Title

## H2 - Section

### H3 - Subsection

Code Blocks

```ts
const hello = 'world'
```

Lists

- Item 1
- Item 2
  - Nested item

1. First
2. Second

Links

[Internal Link](/docs/getting-started/installation)
[External Link](https://example.com)

Tables

| Column 1 | Column 2 |
| -------- | -------- |
| Cell 1   | Cell 2   |

Next Steps

Explore the Components available in the layer.

ConfigurationEdition