Quick Reference

A cheatsheet of essential Rhizome syntax and features. Each section is transcluded from its full guide for easy access.

Wiki-Links

Wiki-links are the primary way to connect notes in Rhizome:

Syntax	Result
`[[Note Title]]`	Links to note by title
`[[Note Title\|display text]]`	Shows "display text" but links to note
`[[Note#Section]]`	Links to specific heading in note
`[[Note#^block-id]]`	Links to specific block by ID
`[[Note#Section\|display text]]`	Anchor link with custom text
`[[Knowledge Graph Basics]]`	Knowledge Graph Basics
`[[Knowledge Graph Basics\|learn about graphs]]`	learn about graphs
`[[Embeds and Anchors#Heading Anchors]]`	Embeds and Anchors

💡

Wiki-links are case-insensitive. [[welcome to rhizome]] and [[Welcome to Rhizome]] link to the same note.

Clicking a wiki-link opens it in a split pane, letting you view both notes side-by-side. See Split-View Navigation for more.

For advanced features like embedding notes inline (![[...]]), see Embeds and Anchors.

Anchor Links

↗ Embeds and Anchors#combined-syntax

Combined Syntax

You can combine all features:

Syntax	Purpose
`[[Note]]`	Basic link
`[[Note\|#Section]]`	Link with anchor
`[[Note\|#^block-id]]`	Link to block
`[[Note\|#Section\|alias]]`	Link with anchor and alias
`![[Note]]`	Full embed
`![[Note\|#Section]]`	Section embed
`![[file.pdf]]`	PDF embed
`![[file.pdf#page=5]]`	PDF at specific page

Callout Types

↗ Callouts#supported-callout-types

Supported Callout Types

Syntax	Type	Use Case
`[!note]`	Note	General information
`[!tip]`	Tip	Helpful suggestions
`[!warning]`	Warning	Important caveats
`[!danger]`	Danger	Critical warnings
`[!info]`	Info	Background information

Foldable Callouts

↗ Callouts#foldable-callouts

Foldable Callouts

Add + or - after the type to make callouts collapsible:

+ starts expanded (user can collapse)
- starts collapsed (user can expand)

This callout starts expanded. Click the arrow to collapse it.

> [!tip]+ Click to Expand
> This content is visible by default.

> [!warning]- Collapsed by Default
> This content is hidden by default.

Use cases for foldable callouts:

Use Case	Type	State
FAQ answers	`[!note]-`	Collapsed
Optional deep-dives	`[!info]+`	Expanded
Spoiler content	`[!warning]-`	Collapsed
Technical appendix	`[!note]-`	Collapsed

Diagram Types

↗ Diagrams#diagram-syntax-reference

Diagram Syntax Reference

Diagram Type	Keyword
Flowchart	`graph` or `flowchart`
Sequence	`sequenceDiagram`
Class	`classDiagram`
State	`stateDiagram-v2`
ER	`erDiagram`
Pie	`pie`

ℹ️

Resources

Full Mermaid documentation is available at mermaid.js.org. The site includes a live editor for testing diagrams.

Math Syntax

↗ Mathematical Notation#syntax-reference

Syntax Reference

Superscript: x^2 → $x^2$
Subscript: x_i → $x_i$
Fraction: \frac{a}{b} → $\frac{a}{b}$
Square root: \sqrt{x} → $\sqrt{x}$
Sum: \sum_{i=1}^{n} → $\sum_{i=1}^{n}$
Product: \prod_{i=1}^{n} → $\prod_{i=1}^{n}$
Integral: \int_{a}^{b} → $\int_{a}^{b}$
Limit: \lim_{x \to \infty} → $\lim_{x \to \infty}$

ℹ️

LaTeX Escaping

In MDX files, use single backslashes for LaTeX commands. The processor handles the escaping correctly during rendering.

PDF Embedding

↗ Embeds and Anchors#pdf-embeds

PDF Embeds

Embed PDF files using the same wikilink syntax:

![[document.pdf]]
![[document.pdf#page=5]]

See PDF Viewer for full documentation on PDF embedding, page deep linking, viewer controls, and external URLs.

↗ Split-View Navigation#opening-panes

Opening Panes

Action	Result
Click a wiki-link	Opens in new pane on the right
Click another link	Replaces the rightmost pane
Click a link in a pane	Opens in that pane

The system keeps track of which pane you're interacting with and updates accordingly.

Build Commands

↗ Welcome to Rhizome#build-commands

Build Commands

Command	Description
`npm run gen`	Generate content (manifest, search index, etc.)
`npm run dev`	Start development server with hot reload
`npm run build`	Build for production (runs gen automatically)
`npm run watch`	Watch content files and regenerate on changes
`npm run test`	Run unit tests
`npm run test:e2e`	Run E2E tests with Playwright
`npm run test:e2e:ui`	Run E2E tests with interactive UI

Quick Reference

A cheatsheet of essential Rhizome syntax and features. Each section is transcluded from its full guide for easy access.

Wiki-Links

↗ Markdown Guide#wiki-links

Wiki-Links

Wiki-links are the primary way to connect notes in Rhizome:

Syntax	Result
`[[Note Title]]`	Links to note by title
`[[Note Title\|display text]]`	Shows "display text" but links to note
`[[Note#Section]]`	Links to specific heading in note
`[[Note#^block-id]]`	Links to specific block by ID
`[[Note#Section\|display text]]`	Anchor link with custom text
`[[Knowledge Graph Basics]]`	Knowledge Graph Basics
`[[Knowledge Graph Basics\|learn about graphs]]`	learn about graphs
`[[Embeds and Anchors#Heading Anchors]]`	Embeds and Anchors

💡

Wiki-links are case-insensitive. [[welcome to rhizome]] and [[Welcome to Rhizome]] link to the same note.

Clicking a wiki-link opens it in a split pane, letting you view both notes side-by-side. See Split-View Navigation for more.

For advanced features like embedding notes inline (![[...]]), see Embeds and Anchors.

Anchor Links

↗ Embeds and Anchors#combined-syntax

Combined Syntax

You can combine all features:

Syntax	Purpose
`[[Note]]`	Basic link
`[[Note\|#Section]]`	Link with anchor
`[[Note\|#^block-id]]`	Link to block
`[[Note\|#Section\|alias]]`	Link with anchor and alias
`![[Note]]`	Full embed
`![[Note\|#Section]]`	Section embed
`![[file.pdf]]`	PDF embed
`![[file.pdf#page=5]]`	PDF at specific page

Callout Types

↗ Callouts#supported-callout-types

Supported Callout Types

Syntax	Type	Use Case
`[!note]`	Note	General information
`[!tip]`	Tip	Helpful suggestions
`[!warning]`	Warning	Important caveats
`[!danger]`	Danger	Critical warnings
`[!info]`	Info	Background information

Foldable Callouts

↗ Callouts#foldable-callouts

Foldable Callouts

Add + or - after the type to make callouts collapsible:

+ starts expanded (user can collapse)
- starts collapsed (user can expand)

This callout starts expanded. Click the arrow to collapse it.

> [!tip]+ Click to Expand
> This content is visible by default.

> [!warning]- Collapsed by Default
> This content is hidden by default.

Use cases for foldable callouts:

Use Case	Type	State
FAQ answers	`[!note]-`	Collapsed
Optional deep-dives	`[!info]+`	Expanded
Spoiler content	`[!warning]-`	Collapsed
Technical appendix	`[!note]-`	Collapsed

Diagram Types

↗ Diagrams#diagram-syntax-reference

Diagram Syntax Reference

Diagram Type	Keyword
Flowchart	`graph` or `flowchart`
Sequence	`sequenceDiagram`
Class	`classDiagram`
State	`stateDiagram-v2`
ER	`erDiagram`
Pie	`pie`

ℹ️

Resources

Full Mermaid documentation is available at mermaid.js.org. The site includes a live editor for testing diagrams.

Math Syntax

↗ Mathematical Notation#syntax-reference

Syntax Reference

Superscript: x^2 → $x^2$
Subscript: x_i → $x_i$
Fraction: \frac{a}{b} → $\frac{a}{b}$
Square root: \sqrt{x} → $\sqrt{x}$
Sum: \sum_{i=1}^{n} → $\sum_{i=1}^{n}$
Product: \prod_{i=1}^{n} → $\prod_{i=1}^{n}$
Integral: \int_{a}^{b} → $\int_{a}^{b}$
Limit: \lim_{x \to \infty} → $\lim_{x \to \infty}$

ℹ️

LaTeX Escaping

In MDX files, use single backslashes for LaTeX commands. The processor handles the escaping correctly during rendering.

PDF Embedding

↗ Embeds and Anchors#pdf-embeds

PDF Embeds

Embed PDF files using the same wikilink syntax:

![[document.pdf]]
![[document.pdf#page=5]]

See PDF Viewer for full documentation on PDF embedding, page deep linking, viewer controls, and external URLs.

↗ Split-View Navigation#opening-panes

Opening Panes

Action	Result
Click a wiki-link	Opens in new pane on the right
Click another link	Replaces the rightmost pane
Click a link in a pane	Opens in that pane

The system keeps track of which pane you're interacting with and updates accordingly.

Build Commands

↗ Welcome to Rhizome#build-commands

Build Commands

Command	Description
`npm run gen`	Generate content (manifest, search index, etc.)
`npm run dev`	Start development server with hot reload
`npm run build`	Build for production (runs gen automatically)
`npm run watch`	Watch content files and regenerate on changes
`npm run test`	Run unit tests
`npm run test:e2e`	Run E2E tests with Playwright
`npm run test:e2e:ui`	Run E2E tests with interactive UI

Quick Reference

Wiki-Links

Wiki-Links

Anchor Links

Combined Syntax

Callout Types

Supported Callout Types

Foldable Callouts

Foldable Callouts

Diagram Types

Diagram Syntax Reference

Math Syntax

Syntax Reference

PDF Embedding

PDF Embeds

Split-View Navigation

Opening Panes

Build Commands

Build Commands

Backlinks

Feature Guides

Quick Reference

Wiki-Links

Wiki-Links

Anchor Links

Combined Syntax

Callout Types

Supported Callout Types

Foldable Callouts

Foldable Callouts

Diagram Types

Diagram Syntax Reference

Math Syntax

Syntax Reference

PDF Embedding

PDF Embeds

Split-View Navigation

Opening Panes

Build Commands

Build Commands

Backlinks

Feature Guides