Skip to main content

Notes: markdown

Headings, paragraphs, bold, italic and code, bullet and numbered lists, checklists (- [ ]), tables, quotes, code blocks, images by URL, inline math $x^2$, display math $$ … $$ or a ```math block, and ```mermaid blocks, which render as diagrams inside the note. It’s the same converter the editor uses when you paste markdown into a note.

Canvases: mermaid flowcharts

Flowcharts and class diagrams become real canvas shapes with arrows bound to them: drag a box and its arrows follow.
flow.mmd

Canvases: class diagrams

Each class becomes a box with its stereotype, name and members, and relations get UML arrowheads.
classes.mmd

Clickable diagrams

click lines work in both canvases and ```mermaid blocks in notes. Only https:// and http:// links are kept, and they open in a new tab. In a code walkthrough, link every class or component box to its definition on GitHub, pinned to a commit.

Other diagram types

Other mermaid diagrams (sequence, state, ER, gantt and so on) can’t become canvases. Put them in a note as a ```mermaid block instead. The canvas’s own JSON works too: octonote canvas pull and octonote canvas push.