Markdown syntax cheat sheet

Markdown is small enough to learn in an afternoon. Below is the order you will actually need it in. Paste anything into the editor to see it rendered.

Headings

# Heading 1
## Heading 2
### Heading 3
#### Heading 4

Six levels, with a space after the hashes. For articles, two or three levels are plenty.

Emphasis

Lists and task lists

- Bullet item
- Second item
  - Indent two spaces for a sub-item

1. Numbered item
2. Second item

- [x] Done
- [ ] Still to do

Task lists render as checkboxes — handy for checklist-style posts.

Quotes, dividers and links

> A quote, for a conclusion or a pull line

---

[SuiLang Tools](https://suilang.net)

Links are [label](url) and survive the copy-to-WYSIWYG path.

Images

![alt text](https://example.com/pic.png)

The easy route is to drag an image straight into the editor or paste a screenshot: it is compressed and inlined locally, with no upload step. If a host blocks hot-linked images, re-upload the picture there.

Tables

| Action | Shortcut |
| --- | --- |
| Bold | ⌘ / Ctrl + B |
| Link | ⌘ / Ctrl + K |

The --- row is required. Align columns with :---, :---: or ---:.

Code blocks

```js
function hello(name) {
  return `Hello, ${name}`;
}
```

Name the language (js, python, bash, json, html, css, sql…) to get highlighting.

Math

Inline: $E = mc^2$

Display:

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

Formulas are extracted before Markdown parsing, so _, * and \ inside them are never mistaken for emphasis.

Diagrams (Mermaid)

```mermaid
flowchart LR
  A[Start] --> B{Decision}
  B -- Yes --> C[Do this]
  B -- No --> D[Do that]
```

The three you will use most: flowchart, sequenceDiagram and gantt.

Keyboard shortcuts

Next: turning Markdown into HTML you can paste anywhere.