Markdown Features

This page is the syntax reference for the markdown patterns supported by the current OAT docs app.

Frontmatter

Every page should include title and description in YAML frontmatter.

---
title: Page Title
description: A short summary of the page.
---

Callouts

GitHub-style blockquote callouts are supported.

> [!NOTE]
> Useful supporting context.

> [!WARNING]
> Important caution for the reader.

Mermaid Diagrams

Fenced code blocks with mermaid are rendered as diagrams.

```mermaid
flowchart LR
  A[Read docs tree] --> B[Generate index]
```

Tabs

Tab groups use the existing tab transform syntax:

=== "pnpm"

    pnpm install

=== "npm"

    npm install

Code Blocks

Standard fenced code blocks support syntax highlighting and optional file-title metadata.

```typescript title="src/example.ts"
const greeting = 'hello world';
console.log(greeting);
```

Authoring Reminder

After adding or reorganizing docs pages, refresh the generated docs surface:

pnpm -w run cli -- docs generate-index --docs-dir apps/oat-docs/docs --output apps/oat-docs/index.md