Markdown on one page.What you type, what you get.

Headings, text and line breaks

A blank line starts a new paragraph. A single line break inside a paragraph is ignored, and the lines join up. To force a break, end the line with two spaces or a backslash.

Lists, task lists and tables

- Milk
- Bread
  - Rye
  - Wheat

1. Open the folder
2. Pick a file

- [x] Write the plan
- [ ] Review it

A bulleted list starts each line with -, * or +. Indent by two or four spaces to nest. A numbered list needs only the first number to be right. A task list is a bulleted list with [ ] or [x] in front, and shows as checkboxes.

| Plan  | Price | Users |
|-------|------:|:-----:|
| Free  |    $0 |   1   |
| Team  |   $12 |  10   |

In a table, the second line separates the header from the rows. :--- aligns a column left, ---: right and :---: centred. The columns do not need to line up in the text. To put a | inside a cell, write \|.

Code

Wrap inline code in single backticks. For a block, put three backticks on the line before and the line after, and write the language after the opening ones to get syntax colours:

```swift
let greeting = "Hello"
```

A block marked diff colours the lines that start with + and -. A block marked mermaid becomes a diagram.

Links and images

[DotMD](https://getdotmd.com)
![A cat on a keyboard](assets/cat.png)
[the plan](plan.md)
[setup](#setup)

A link has its text in square brackets and its address in round ones. A web address on its own becomes a link too. An image is a link with a ! in front; its text describes it for screen readers. Paths are relative to the document, and a link can point to another .md file or to a heading, whose anchor is its text in lowercase with spaces turned into -.

For long or repeated addresses, put them at the bottom and refer to them by a short name: [guide][1], then [1]: https://example.com/guide on a line of its own.

Callouts, comments and front matter

> [!NOTE]
> Useful information that users should know.

A quote whose first line is [!NOTE], [!TIP], [!IMPORTANT], [!WARNING] or [!CAUTION] becomes a coloured box, the same syntax as on GitHub.

• Comments that do not show on the page: <!-- a note only visible in the text -->.
• Collapsible sections with HTML's <details> and <summary>, with blank lines around the Markdown inside.
• Front matter: a block between two --- lines on the very first lines of the file, with a title, tags or a status. DotMD shows it as a Properties card above the document.

Math and diagrams

Two extras that GitHub and DotMD both draw. A formula goes between dollar signs, $E = mc^2$, or between double ones on its own line: Markdown math with LaTeX. A diagram is a code block marked mermaid, with its text inside: Mermaid diagrams.

Try it

The quickest way to learn the marks is to see them rendered. Open any .md file in DotMD and read it formatted, with tables, code, callouts, diagrams and formulas drawn. Reading is free. In the editor, the Insert menu types the symbols for you, so you do not need to remember any of this.

Questions about Markdown syntax

More questions