Authoring Documentation
How to add and edit docs pages, use components, and format content.
Authoring Documentation
All docs pages are MDX files in src/content/docs/. MDX = Markdown + JSX components.
Adding a New Page
- Create a file:
src/content/docs/<section>/<your-page>.mdx - Add required frontmatter:
---
title: "Your Page Title"
description: "One sentence describing this page."
section: "Features" # must match an existing section name exactly
order: 25 # controls position in sidebar (lower = higher)
author: "yourgithub" # optional
---
- Write content in Markdown below the frontmatter.
Available Components
Import at the top of your .mdx file:
import InteractiveChart from "../../../components/InteractiveChart.astro";
import BarChart from "../../../components/BarChart.astro";
Charts
<InteractiveChart
title="My chart title"
type="bar" {/* "bar" | "line" | "doughnut" */}
data={[
{ label: "Thing A", value: 42 },
{ label: "Thing B", value: 18 },
]}
caption="Optional caption below chart"
/>
Code Blocks
Use fenced code blocks with a language specifier:
```typescript
const x: number = 42;
```
Tables
Tables are automatically wrapped in a horizontal-scroll container. Use standard Markdown table syntax:
| Column A | Column B | Column C |
| -------- | -------- | -------- |
| Value | Value | Value |
Callouts / Notes
Use blockquote syntax — it renders as a styled note block:
> **Note:** This feature requires Redis to be configured.
Sections
Current sections (must match exactly in frontmatter):
Getting StartedFeaturesDaemonAPIConfigurationAdminPanelArchitectureDevelopment