Markdown basics

Last updated

Notate uses standard markdown (CommonMark plus GitHub-flavored Markdown), with a few extras.

For the complete syntax with every example rendered, see the markdown guide.

Text and structure

  • Headings: #, ##, ###
  • Emphasis: **bold**, *italic*, ~~strikethrough~~
  • Lists: - for bullets, 1. for numbered
  • Tasks: - [ ] and - [x]
  • Quotes: > a blockquote
  • Standard links: [label](https://example.com)
  • Wiki-links between notes: [[Note title]], with backlinks tracked automatically

Code, tables, and diagrams

Wrap inline code in backticks. For a block of code, use a fenced block with an optional language name and Notate highlights dozens of languages.

Notate also renders GitHub-style tables, and a fenced mermaid block renders as a diagram in Split and Preview: flowcharts, sequence diagrams, and charts, right in your note.

View modes

Switch between Editor, Split, Live, and Preview from the row above the text to write in raw markdown or a rendered view, whichever suits the moment.

You do not have to type the syntax by hand. Formatting as you write covers the toolbar that appears over selected text and the / menu for inserting blocks.