Home/Docs/Markdown Reference

Markdown Reference

Every Markdown construct Binderus supports, in one page. Standard CommonMark plus GitHub-flavored extensions plus a few Binderus-specific niceties (wiki links, callouts, KaTeX).

Headings

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

Headings auto-generate a table-of-contents in the editor sidebar. Six levels supported; a # at the start of a line is required (no Setext-style underlines).

Emphasis

ResultMarkdown
italic*italic* or _italic_
bold**bold** or __bold__
bold italic***both***
strikethrough~~strike~~
highlight==highlight==
inline code`code`

Lists

- Unordered item
- Another item
  - Nested item
- Third item

1. Ordered item
2. Another item
3. Third item

- [ ] Todo item
- [x] Completed todo
- [ ] Another todo

Indent two spaces (or one tab) to nest. Todos toggle on click in the editor.

[Inline link](https://example.com)
[Link with title](https://example.com "Hover title")
<https://auto-link.example.com>
[Reference link][ref]

[ref]: https://example.com
[[Note Title]]
[[Note Title|Display text]]
[[Note Title#Heading]]
[[Note Title^block-id]]

Binderus autocompletes wiki links as you type [[. Linking to a non-existent note creates it on click. Backlinks for every note are shown at the bottom of the editor.

Images

![Alt text](path/to/image.png)
![Alt with title](path/to/image.png "Hover title")
![](https://example.com/remote.png)

Pasting / dropping an image inserts a relative link automatically — see Image storage for the storage flow.

Code blocks

```python
def hello():
    print("Hello, Binderus")
```

Specify a language after the opening fence for syntax highlighting (100+ languages via Prism). Omit the language for a plain monospace block.

Inline code uses single backticks: `code`. Backticks inside inline code: use double-backticks — ``code with `backtick```.

Block quotes

> A single-line quote.
>
> A second paragraph in the same quote.
>
> > Nested quote.

Tables

| Column A | Column B | Column C |
|----------|---------:|:--------:|
| left     |    right |  center  |
| cell     | cell     | cell     |

Alignment is set in the separator row: |---| default, |---:| right, |:---:| center.

Callouts (Binderus-specific)

> [!note]
> A note callout.

> [!warning]
> A warning callout.

> [!tip]
> A tip / success callout.

> [!info] Custom Title
> You can override the title.

Recognized types: note, tip, info, warning, danger, success, quote. Each renders with a colored left bar and an icon.

Math (KaTeX)

Inline math: $E = mc^2$

Block math:
$$
\frac{n!}{k!(n-k)!}
$$

KaTeX renders most LaTeX math primitives. Macros and environments work; full reference at katex.org/docs/supported.html.

Frontmatter (YAML)

---
title: My Note
tags: [project, draft]
created: 2026-04-28
---

Note body starts here.

YAML frontmatter at the top of a file is parsed and exposed to plugins via ctx.editor.frontmatter. Tags listed there are aggregated into the tag pane.

Other

ConstructMarkdown
Horizontal rule--- or *** on its own line
Line break (within paragraph)two trailing spaces, or \ at end of line
Hard paragraph breakblank line
HTML pass-throughraw HTML is preserved (<kbd>Cmd</kbd>, etc.)
FootnoteText[^1] + [^1]: Footnote body.
Definition listTerm\n: Definition

Not currently supported

  • Mermaid diagrams — can be added via a plugin.
  • Inline emoji shortcodes (:smile:) — paste real Unicode emoji instead.
  • Custom block syntax like Pandoc's ::: — use callouts (above) or HTML.
Want a printable cheat-sheet? Hit Cmd P in your browser on this page — the print stylesheet collapses sidebar + nav and gives you a clean one-pager.