Guide

Markdown syntax, by example

A compact Markdown reference for headings, emphasis, links, images, lists, tasks, quotes, code, and tables.

Markdown uses a few visible characters to describe structure. Most notes need only headings, paragraphs, lists, links, and emphasis. You can try the examples live as you read.

Headings

Put one to six # characters before a heading, followed by a space.

# Main heading
## Section
### Smaller section

Use headings for an outline, not to make every line large. A note with two or three useful sections is often easier to scan than one enormous paragraph.

Emphasis and links

**bold**
*italic*
[Link text](https://example.com)
![Image description](images/diagram.png)

The image form points to a resource. Move the image with the note when you export a folder. A link destination may be a web address or a relative path to another file.

Lists and tasks

- First item
- Second item
  - Nested item

1. First step
2. Second step

- [ ] Something to do
- [x] Something finished

Task-list checkboxes are common, but they are an extension in many Markdown implementations. If a tool does not render them, the source stays legible.

Quotes and code

> A quoted thought.

Use `inline code` for a command or exact name.

```swift
let note = "Hello"
```

For a fenced code block, type three backticks on their own line before and after the code. Add a language name after the opening fence when it helps a renderer highlight syntax.

Tables

Some Markdown tools support pipe tables:

| Item | Status |
| --- | --- |
| Draft | In progress |

Tables are useful for small, simple comparisons. They become cumbersome for long text or complex layouts. Tables are not part of the core CommonMark specification; check a destination tool before depending on them.

Compatibility matters

The CommonMark specification defines a shared core. Our CommonMark compatibility guide explains where extensions begin. Apps may add their own syntax for tasks, highlights, callouts, math, or wiki links. Keep a sample note with the features you use and test it when changing tools. The cheat sheet is a shorter reference for everyday writing.