CheatMarkdown Plain-text formatting
Light · Postcard
102 × 152 mm · PDF
Dark · Postcard
102 × 152 mm · PDF
Ink saver · Postcard
102 × 152 mm · PDF
Light · A4 landscape
297 × 210 mm · PDF
Dark · A4 landscape
297 × 210 mm · PDF
Ink saver · A4 landscape
297 × 210 mm · PDF
Light · A3 landscape
420 × 297 mm · PDF
Dark · A3 landscape
420 × 297 mm · PDF
Ink saver · A3 landscape
420 × 297 mm · PDF
Start here
# TitleHeading, level 1
**bold** *italic*
Emphasis
- itemBullet list
[text](<url>)
Link
Image
`code`Inline code
> quoteBlockquote
| a | b |Table (GFM)
Concepts
- Plain text .md file
- Syntax tree blocks, inlines
- HTML or PDF, docs
Headings & text
# H1 ## H2 ### H3
ATX headings, 1 to 6 hashes
**bold** __bold__
Strong emphasis
*italic* _italic_
Emphasis
***both***Bold and italic
~~text~~Strikethrough (GFM)
Title =====
Setext heading, H1 (underline with ---: H2)
snake\_caseBackslash escapes a special character
Escapable: \ ` * _ { } [ ] ( ) # + - . ! |
line (two spaces)
Hard line break at end of line
A backslash at line end also breaks; a single newline is just
a space.
--- *** ___Thematic break (horizontal rule)
<!-- note -->
Comment, not rendered
<br>Raw HTML line break
Lists
- item * item + item
Bullet list
1. itemOrdered list
Only the first number matters: 1. 1. 1. renders as 1. 2. 3.
- nestedNest by indenting under the item text
- [ ] - [x]Task list, open and done (GFM)
5. itemOrdered list starting at 5
- a (blank line) - b
Blank line between items makes a loose list
Links & images
[text](<url>)
Inline link
[text](<url> "title")
Link with hover title
<https://example.com>
Autolink in angle brackets
Image
[](<url>)
Image that links
[text][id]Reference link
[id]: <url> "title"
Define a reference, anywhere in file
[text](#section-name)
Link to a heading anchor (lowercase, hyphens)
https://example.com
Bare URL auto-linked (GFM)
Code & quotes
`code`Inline code
``a ` b``Inline code containing a backtick
```<lang>Fenced code block with language
Close with a matching ``` line; use ~~~ or four backticks to
wrap a block containing ```.
codeIndented code block, 4 spaces
> quoteBlockquote
> > nested
Quote inside a quote
> [!NOTE]
Alert: NOTE, TIP, IMPORTANT, WARNING, CAUTION (GitHub)
```diffHighlight +/- lines as a diff
Tables & extras
| a | b |Table header row (GFM)
| --- | --- |Delimiter row, required under the header
| :--- | :---: | ---: |
Align left, centre, right
\|Literal pipe inside a cell
text[^1]Footnote reference (GFM)
[^1]: noteFootnote text, anywhere in file
<details><summary>
Collapsible section, raw HTML
$x^2$Inline math (GitHub, others)
```mermaidDiagram block (GitHub, others)
Recipes
# ProjectOne-line summary.## Install```shnpm install project```| Name | Qty | Price || :--- | --: | ----: || Tea | 2 | 3.50 |<details><summary>Show log</summary>```output here```</details>See the spec[^1] or the [docs][d].[^1]: CommonMark 0.31.2.[d]: https://commonmark.org "Docs"
