Loading...

Project Documentation

Loading documentation...

Recent Activity

Keyboard shortcuts

Ctrl+K / Cmd+K: Command palette
j / ArrowDown: Next document
k / ArrowUp: Previous document
?: Show this overlay
Ctrl+F / Cmd+F: Page search (current doc)
Ctrl+G / Cmd+G: Global search (all docs)
Esc: Close search / menu / overlay

Display

Ctrl+Shift+D: Toggle theme
Ctrl+Alt+S: Open settings
Ctrl+Shift+U: User profile
Ctrl+Alt+T: Edit tags (when enabled)
Ctrl+Shift+I: Project info
Ctrl+Shift+A: Open analytics
Ctrl+Alt+N: Add page (when enabled)
Ctrl++ / Cmd++: Increase font size
Ctrl+- / Cmd+-: Decrease font size
Ctrl+0 / Cmd+0: Reset font size
Ctrl+Alt+W: Toggle full width
Ctrl+E / Cmd+E: Edit page (when enabled)

Diagram viewer

+ / -: Zoom in / out
0: Reset zoom
Drag: Pan diagram
Scroll: Zoom with mouse wheel

Project info

Markdown cheat sheet

docId: Unique identifier for the document. Required for comments, search, and linking. Use lowercase with hyphens (e.g. my-topic-doc).
ownerEmail: Document owner email. Required for feedback and ownership.
tags: Optional array for categorization. Format: tags: [a, b, c] or tags: a, b, c.
Format: All three must be inside a YAML block at the very top of the file, between --- delimiters.

---
docId: my-doc-id
ownerEmail: you@example.com
tags: [topic, example]
---

The build script enforces docId and ownerEmail for non-root docs; missing frontmatter causes build failure.

No space after #: #Heading → # Heading
No space after - or *: -item → - item
No space after >: >text → > text
No space after - [ ]: - [ ]task → - [ ] task
Missing blank line before headings: Add blank line above ## Section
Missing blank line before code blocks: Add blank line before ```
Missing alignment row in tables: Add | --- | --- | under header row
Admonition without > on each line: Every line of an admonition needs > prefix

When in doubt, add a space or blank line.

Bold: **text** or __text__
Italic: *text* or _text_
Strikethrough: ~~text~~
Inline code: `code`
Link: [text](url)
Image: ![alt](url)
Heading 1–6: # to ###### + space
Blockquote: > text
Horizontal rule: --- or *** or ___

Bullet list: - item or * item
Numbered list: 1. item
Task list: - [ ] or - [x]
Table: | Col | Col | + |---|---|
Code block: ```lang + newline + code

Note: > [!NOTE] + newline + > content
Tip: > [!TIP]
Important: > [!IMPORTANT]
Warning: > [!WARNING]
Caution: > [!CAUTION]
Danger: > [!DANGER]
Info: > [!INFO] (alias for Note)
Custom title: > [!TIP] Custom title

Flowchart: ```mermaid + flowchart LR + A --> B
Sequence: sequenceDiagram + A->>B: msg
State: stateDiagram-v2 + [*] --> State1
Gantt: gantt + section + Task: date, Nd
Class: classDiagram + Class : +field
ER: erDiagram + A ||--o{ B : rel

Validate syntax at mermaid.live

0 of 0