Markdown

Everything below is plain Markdown (GitHub-style) that Mahfouz recognizes and renders specially:

Callouts

A callout is a blockquote whose first line is only a marker. It uses the same syntax as GitHub’s alerts, so a vault pushed to GitHub renders its callouts there too:

> [!TIP]
> Press **Ctrl+B** (**Cmd+B** on a Mac) to make text bold.

There are five types: NOTE, TIP, IMPORTANT, WARNING and CAUTION. Upper or lower case both work. In Preview mode a callout shows as a tinted box with the type’s icon and name. A marker followed by other text, an unknown type, or a quote inside a list stays a plain blockquote.

To insert one, open the toolbar’s Callout menu and pick a type. With the cursor inside a callout, picking another type changes it, and picking its own type turns it back into a plain quote. A callout at the top of a note isn’t the note’s title: the title comes from the line after it.

Code blocks

Put code between two lines of three backticks, with its language after the opening ones:

```ts
const total = items.reduce((sum, item) => sum + item.price, 0);
```

You can also insert one with Code block in the toolbar’s Code menu or /code in the slash menu. On an empty line it adds an empty block with the cursor in it. With text selected (or on a line with text), it puts those lines in a block, and inside a block it turns the block back into plain lines. Type the opening backticks and the language and press Enter: the closing backticks are added below and the cursor goes between them, so the block ends there instead of taking in the rest of the note. Since 0.13.0

A code block shows as a card, highlighted for its language. In Preview mode the backticks stay hidden, even while you edit the code Since 0.13.0, and the cursor steps over them. Backspace in an empty block removes the block. The card’s header shows a collapse chevron and the language, and pointing at the block shows its buttons:

• The chevron at the left collapses the block to its header and its line count (“· 12 lines”), or expands it again. Since 0.13.0
• The language button shows the block’s language. Click it to pick another from the Language menu, which you can search. Since 0.13.0
• The moon or sun button shows this one block dark or light, whatever the note’s appearance. Since 0.13.0
• The line-numbers button numbers the block’s lines, or stops numbering them.
• Copy code copies the whole block’s code, without the backticks, even while it’s collapsed or folded.

Picking a language rewrites only the word after the opening backticks, so showLineNumbers and anything else after it stay. The change is never a suggestion, even in Suggesting mode, and one undo takes it back. A block written as text (or with no language) shows Plain text, and a file extension works as a language too: py is Python, rs is Rust. Since 0.13.0

Collapsing a block and switching it light or dark are remembered on this device only, for that note. They aren’t written to the note, so they don’t sync, aren’t committed, and collaborators see the block as it is. Since 0.13.0

Line numbers are kept in the note itself, as showLineNumbers after the language (```ts showLineNumbers), so they show for everyone you share the note with. You can also type it yourself. A block with no language gets text as its language when you number it. Switch to Source mode to see and edit its backticks. Since 0.13.0

When a code block is the last thing in a note, press ↓ on its last line of code, or click below the text, to start a new line under the block. Pressing Enter inside the block only adds lines of code. Since 0.13.0

With the cursor in a block, ShiftF10 (or Mod. Since 0.20.0, or the Menu key) opens the block’s actions as a menu: Language…, Collapse block, the light or dark switch, Line numbers and Copy code. Since 0.13.0

Folding code Since 0.13.0

In Preview mode, pointing at a code block shows a chevron in the rail beside the line numbers on each line where a region starts: a function, a class, an object or an indented section. Click it to fold that region to its first line and a “…”, and click it again to unfold it. Languages without their own folding rules fold by indentation.

Folds are temporary: switching the note to Source mode, picking a new language for the block, or reloading unfolds them. The fold keys act only with the cursor on a line of code in Preview, and do nothing elsewhere:

Math

Write math in LaTeX between dollar signs: $…$ for math inside a sentence, $$…$$ for a formula on its own lines.

The area of a circle is $\pi r^2$.

$$
\int_0^1 x^2 \, dx = \frac{1}{3}
$$

So that prices don’t turn into math, the rules are Pandoc’s:

• A $ followed by a space doesn’t start math.
• The closing $ must come right after a non-space character, and mustn’t be followed by a digit.
• \$ is a literal dollar sign.

Math is rendered in Preview mode and on published pages. In Preview, a formula is one object. Since 0.20.0

• Backspace after a formula, or Delete before one, removes the whole formula.
• With the cursor at its edge, the formula stays drawn.
• To edit its source, click the formula (the cursor lands just inside the opening $), or press Left or Right at its edge to step inside.
• Up and Down pass over it, and Shift with an arrow key selects it whole.

A formula on its own lines is a block: a click on it shows its source to edit, and pointing at it shows Edit, Copy and Delete (see Clicking in Preview). Since 0.20.0

A horizontal rule, a table, an image card, an embed or a table of contents is a block too: in Preview, Backspace at the start of the line with text after it deletes the whole block in one press, and undo brings it back. On an empty line after one, Backspace deletes only that line (see the editor). Since 0.20.0

Table of contents

A line holding only [TOC] (or [[_TOC_]]) shows a numbered Contents list (1., 1.1., 2.…) of the note’s headings, each linking to its section. Every heading is listed except the title, a level 1 heading on the note’s first line, and headings inside quotes or lists. Numbers follow the heading levels, counted from the shallowest level listed, and a skipped level counts as 0: a level 4 heading straight under a level 2 one is 1.0.1. Since 0.14.0 It shows in Preview mode, where clicking an entry jumps to the heading, and on published pages. In Preview, the heading’s line stays shaded until you click, type or move the cursor. A click anywhere else on the list shows the [TOC] line to edit, and pointing at it shows Edit, Copy and Delete. Since 0.20.0 With no headings, Preview shows No headings yet and a published page shows nothing. Since 0.20.0 From the keyboard, ↓ from the line above moves into the list; ↑ and ↓ move between entries, and Enter jumps to one (see Block widgets).

Heading numbers Since 0.14.0

Number headings, at the bottom of the toolbar’s Heading menu Since 0.15.0 (or /number in the slash menu, or the command palette), numbers the note’s headings with the same numbers its table of contents uses: the first section is 1., its first subsection 1.1., the next section 2., and so on. The title on the first line stays unnumbered. In Preview the number comes before each heading; in Source it sits in the left margin, so the text doesn’t move while you type. The outline shows the numbers too, and so does the published page.

The numbers are drawn on screen, never written into the note: links to a heading and exports are unchanged. The setting is the note’s heading_numbers: true attribute, so it travels with the note to collaborators and other devices. Choose Number headings again to turn it off.

Tables

Insert one via the toolbar’s Table button (a hover grid, minimum 8×8, that grows as you approach its edge; pick rows × columns, it shows the size as you hover). In Preview mode a table is always a live, editable grid instead of raw pipe syntax:

• Click a cell to edit it inline; Tab/Shift+Tab moves between cells (Tab at the last cell adds a new row); Enter commits the cell.
• Hover the bottom or right edge for a + button to add a row or column.
• Each column header and each body row has a grip. Drag a grip to move its column or row, or click it for a menu:
  • Row: Insert row above, Insert row below, Move row up, Move row down and Delete row.
  • Column: Insert column left, Insert column right, Move column left, Move column right, Align left, Align center, Align right (the current alignment is checked) and Delete column. Alignment writes :---, :---: or ---: under the header.

  An item that can’t be used is dimmed and says why, such as “Already first” or “A table needs a column”. Grips show on one-row and one-column tables too; the header row has no row grip. Each action is one undo.

• ShiftF10, Mod. Since 0.20.0 or the Menu key in a cell opens the same items for its row and column in one menu (a header cell gets the column items only). When the menu closes, you’re back in the cell. Since 0.20.0 The menu starts with Wrap text (checked when it’s on), then Convert to database… where the table offers it. The wrap toggle and the + buttons also answer Enter and Space.
• While Suggesting, and in a read-only note, the table can’t be edited: there are no grips, + buttons or menus.