Markdown Cheat Sheet

Use one leading # through six for heading levels. Keep one space after the marker and leave blank lines around larger blocks when portability matters.

# Page title

Subsection

bold italic bold italic strikethrough

| Syntax | Result |
| --- | --- |
| `` `code` `` | Inline code. |
| `**text**` | Strong emphasis. |
| `*text*` | Emphasis. |
| `~~text~~` | Strikethrough in GFM. |
| `\*literal\*` | Escaped punctuation. |

Unordered lists use -, *, or +; ordered lists use a number and period. Indent nested content consistently, commonly by two or four spaces.

- Install dependencies
- Configure the app
  - Set the port
  - Set the database URL

1. Draft
2. Review
3. Publish

- [ ] Write tests
- [x] Run lint

Task-list syntax is a GFM extension and may not render as checkboxes in every Markdown engine.

Inline links keep the destination beside the label. Reference links reduce repetition when the same destination appears multiple times.

[CommonMark](https://spec.commonmark.org/)

[project docs][docs]

[docs]: https://docs.example.com/ "Project documentation"

![A descriptive caption](images/diagram.png "Optional title")

Use meaningful link text and useful image alt text. A bare URL may autolink in GFM, but explicit labels are usually clearer.

Use inline code for short tokens and fenced blocks for multi-line examples. A language tag enables syntax highlighting when the renderer supports it.

Run `pnpm test` before opening a pull request.

```python
print("Hello, Markdown")

A blockquote can contain multiple paragraphs.

— Source or attribution

To show a literal fence inside a fenced example, use a longer fence around it.

GFM tables require a header row and a delimiter row. Colons control alignment; the separator line is also visually useful as a horizontal rule when written with three hyphens alone.

| Name | Status | Count |
| :--- | :----: | ---: |
| API  | Ready  | 12   |
| Web  | Draft  | 3    |

---

A blank line starts a new paragraph. Two trailing spaces create a hard line break in many implementations, but an explicit <br> or separate paragraphs can be more maintainable depending on the renderer.

First paragraph.

Second paragraph.

Line one  
Line two

Footnotes, task lists, tables, and autolinks are common extensions rather than universal Markdown features. Confirm the target renderer before depending on them.

A statement with a note.[^1]

[^1]: The note text appears in the footnotes area.

https://example.com

• Markdown Guide
• CommonMark Specification
• GitHub Flavored Markdown Spec