Writing Documentation

Learn how to write and organize your documentation content.

File Structure

Place your documentation files in content/docs/. Files can be organized in subdirectories.

Frontmatter

Every documentation page should have frontmatter at the top:

---
title: Page Title
description: A brief description
sidebar_position: 1
keywords: [keyword1, keyword2]
---

Code Blocks

Use fenced code blocks with language identifiers for syntax highlighting:

function greet(name) {
  return `Hello, ${name}!`;
}

def greet(name):
    return f"Hello, {name}!"

Tables

Links

Use standard Markdown links to reference other pages:

[Getting Started](/getting-started)