Markdown Reference

Paragraphs & Line Breaks

Separate paragraphs with a blank line. Use Shift+Enter for a line break within a paragraph.

First paragraph.

Second paragraph.

Headings

Use 1–6 # characters at the start of a line.

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

Blockquotes

Start a line with > to create a blockquote. Nest with additional > characters.

> This is a blockquote.
>
> > This is a nested blockquote.

Unordered Lists

Use -, *, or + followed by a space. Indent with two spaces to nest.

- Item one
- Item two
  - Nested item
  - Another nested item
- Item three

Ordered Lists

Use numbers followed by a period and a space.

1. First item
2. Second item
3. Third item

Task Lists

Use - [ ] for incomplete and - [x] for completed tasks. Checkboxes are interactive in the preview.

- [ ] Incomplete task
- [x] Completed task
- [ ] Another task

Code Blocks

Wrap code in triple backticks with an optional language identifier for syntax highlighting. 100+ languages supported.

```python
def greet(name):
    return f"Hello, {name}!"
```

A language label and copy button appear automatically above each block.

Math Blocks

Use $$ delimiters or a ```math code block for display equations. Rendered with MathJax 4.

$$
\sum_{i=1}^{n} i = \frac{n(n+1)}{2}
$$

33 TeX packages bundled including AMS, physics, and mhchem. Fully offline — no CDN required.

Tables

Use pipes | and hyphens - to create tables. Colons control column alignment.

| Left-aligned | Center-aligned | Right-aligned |
|:-------------|:--------------:|--------------:|
| Content      |    Content     |       Content |
| More         |      More      |          More |

Shortcut: Ctrl+Enter

Ctrl+Enter adds a row. Ctrl+Shift+Right adds a column. Ctrl+Shift+Left removes a column.

Footnotes

Create a reference with [^id] and define the footnote content anywhere in the document.

Here is a footnote reference[^1].

[^1]: This is the footnote content.

Horizontal Rules

Use three or more hyphens, asterisks, or underscores on a blank line.

---

Also works with *** or ___.

YAML Frontmatter

Add metadata at the top of a file between --- delimiters. Displayed as a styled table in the preview and the sidebar metadata panel.

---
title: My Document
author: Jane Smith
date: 2024-01-15
tags: [markdown, guide]
---

Table of Contents

Type [toc] on its own line to generate a collapsible, clickable table of contents from all headings in the document.

[toc]

Alert / Callout Blocks

Five styled callout types using GitHub-compatible syntax. Each renders with a distinct color and icon.

> [!NOTE]
> Useful information.

> [!TIP]
> Helpful advice.

> [!IMPORTANT]
> Key information.

> [!WARNING]
> Potential issues.

> [!CAUTION]
> Dangerous actions.

Mermaid Diagrams

Create diagrams in fenced code blocks with the mermaid language identifier. Rendering is theme-aware.

```mermaid
graph LR
  A[Start] --> B[Process]
  B --> C{Decision}
  C -->|Yes| D[End]
  C -->|No| B
```

Supports flowcharts, sequence, class, state, ER, Gantt, pie, and git graph diagrams.

Collapsed Sections

Use HTML <details> and <summary> tags for collapsible content.

<details>
<summary>Click to expand</summary>

Hidden content goes here.

</details>

Links

Create links with [text](url) syntax. Add an optional title in quotes.

[Markini](https://rustini.com)
[With title](https://rustini.com "Rustini")

Shortcut: Ctrl+K

Images

Use ![alt](path) syntax. Add optional sizing with =WIDTHxHEIGHT or =WIDTH.

![Screenshot](image.png)
![Resized](image.png =600x400)
![Width only](image.png =600)

Drag & drop images into the editor to insert automatically.

Bold

Wrap text in double asterisks or double underscores.

**bold text**

Shortcut: Ctrl+B

Italic

Wrap text in single asterisks or single underscores.

*italic text*

Shortcut: Ctrl+I

Inline Code

Wrap text in backticks.

`inline code`

Shortcut: Ctrl+`

Strikethrough

Wrap text in double tildes.

~~deleted text~~

Shortcut: Alt+Shift+5

Highlight

Wrap text in double equals signs. Renders as <mark>.

==highlighted text==

Subscript

Wrap text in single tildes.

H~2~O

Superscript

Wrap text in single carets.

X^2^

Inline Math

Wrap LaTeX in single dollar signs. Rendered with MathJax 4.

$E = mc^2$
$\alpha + \beta = \gamma$

Emoji Shortcodes

Type a colon followed by the emoji name. 800+ shortcodes supported via gemoji.

:wave: :rocket: :white_check_mark:
:thumbsup: :fire: :star:

Type : in the editor to get autocomplete suggestions.

Wikilinks

Link to other files in your workspace with double brackets. Links auto-repair when files are moved or renamed.

[[filename]]
[[filename|display text]]
[[filename#heading]]

Underline

Use HTML <u> tags or the keyboard shortcut.

<u>underlined text</u>

Shortcut: Ctrl+U

Smart Punctuation

Automatic conversion of straight quotes to curly quotes and hyphens to em dashes.

"quotes" become “curly quotes”
-- becomes an em dash —