Work & productivity / QUICK REFERENCE

Markdown essentials

Write readable headings, lists, links and code, with CommonMark separated from GitHub extensions.

24 entries

Structure and emphasis

Main heading
# Project notes

Leave a space after the hash. [1]

Second-level heading
## Installation

Preserve a meaningful heading hierarchy. [1]

Third-level heading
### Requirements

Avoid choosing a level only for visual size. [1]

Separate paragraphs
First paragraph. Second paragraph.

A blank line separates paragraph blocks. [1]

Emphasis
*important*

Commonly rendered in italics. [1]

Strong emphasis
**important**

Commonly rendered in bold. [1]

Inline code
`git status`

Keeps code visually distinct from prose. [1]

Horizontal rule
---

Put blank lines around it to avoid heading ambiguity. [1]

Lists and quotations

Unordered list
- First item - Second item

Repeated markers form list items. [1]

Ordered list
1. First step 2. Second step

Renderers number the list from its start value. [1]

Nested bullet
- Parent - Child

Indent sufficiently to belong to the parent item. [1]

Multi-paragraph list item
- First paragraph Second paragraph

Indentation keeps the second paragraph in the same item. [1]

Block quotation
> Quoted sentence.

Use quotations for actual quoted material. [1]

Nested quotation
> Outer quote > > Inner quote

Additional markers nest the quotation. [1]

Code fence
``` git status ```

Fences preserve code as literal content. [1]

Code fence with language
```python print('Atlas') ```

Syntax highlighting depends on the renderer. [1]

Reserved placement, separate from reference controls. No ad network is active.

Updated CommonMark 0.31.2 / labeled GFM additions

Sources

  1. CommonMark specification ↗
  2. GitHub Flavored Markdown specification ↗
  3. Basic writing and formatting ↗