GitHub Flavored Markdown Spec

https://github.github.com/gfm
Admin
A formal specification defining the syntax and semantics of GitHub Flavored Markdown (GFM), a...
Tokens:31,466
Snippets:598
Trust Score:10
Update:6 days ago
Show doc for...
Tokens:
Raw
### Example 262: List starting with empty item

Source: https://github.github.com/gfm

Shows a list that starts with an empty list item.

```markdown
*


```

```html
<ul>
<li></li>
</ul>


```

--------------------------------

### Example 256: List items starting with blank line

Source: https://github.github.com/gfm

Shows list items that start with a blank line, including fenced code blocks and indented code.

```markdown
-
  foo
-
  ```
  bar
  ```
-
      baz


```

```html
<ul>
<li>foo</li>
<li>
<pre><code>bar
</code></pre>
</li>
<li>
<pre><code>baz
</code></pre>
</li>
</ul>


```

--------------------------------

### Example 277: Nested list with ordered list start

Source: https://github.github.com/gfm

Shows a nested list where the inner ordered list starts at 2.

```markdown
1. - 2. foo

```

```html
<ol>
<li>
<ul>
<li>
<ol start="2">
<li>foo</li>
</ol>
</li>
</ul>
</li>
</ol>

```

--------------------------------

### Ordered list item with indentation (Example 232)

Source: https://github.github.com/gfm

Shows how to create an ordered list item with start number 1 and the same contents as the previous example. The input uses a marker '1.' and two spaces, and the output is an ordered list with a single item.

```markdown
1.  A paragraph
    with two lines.

        indented code

    > A block quote.

```

```html
<ol>
<li>
<p>A paragraph
with two lines.</p>
<pre><code>indented code
</code></pre>
<blockquote>
<p>A block quote.</p>
</blockquote>
</li>
</ol>

```

--------------------------------

### Example: Consecutive shortcut reference links

Source: https://github.github.com/gfm

Shows that if whitespace were allowed, [foo] and [bar] would be captured as a single reference link. This example is from the prose explaining the departure from Gruber's syntax.

```markdown
[foo]
[bar]

[foo]: /url1
[bar]: /url2

```

--------------------------------

### Changing ordered list delimiter starts a new list (Example 282)

Source: https://github.github.com/gfm

Shows that changing the ordered list delimiter from '.' to ')' starts a new list. The HTML output uses <ol start="3"> for the second list.

```markdown
1. foo
2. bar
3) baz

```

```html
<ol>
<li>foo</li>
<li>bar</li>
</ol>
<ol start="3">
<li>baz</li>
</ol>

```

--------------------------------

### Example 510: Link with fragment and query

Source: https://github.github.com/gfm

Shows that links can contain fragment identifiers and queries.

```markdown
[link](#fragment)

[link](http://example.com#fragment)

[link](http://example.com?foo=3#frag)

```

```html
<p><a href="#fragment">link</a></p>
<p><a href="http://example.com#fragment">link</a></p>
<p><a href="http://example.com?foo=3#frag">link</a></p>

```

--------------------------------

### Example 570: Case-insensitive shortcut reference link

Source: https://github.github.com/gfm

Link labels are case-insensitive. [Foo] matches [foo].

```markdown
[Foo]

[foo]: /url "title"

```

```html
<p><a href="/url" title="title">Foo</a></p>

```

--------------------------------

### List item indentation example (Example 233)

Source: https://github.github.com/gfm

Shows how far content must be indented to be put under a list item. The input has a list item and a line with two spaces, and the output is a list with a single item.

```markdown
- one

 two

```

--------------------------------

### Example 257: Blank line with spaces after list marker

Source: https://github.github.com/gfm

Shows that the number of spaces following the list marker doesn't change the required indentation when the list item starts with a blank line.

```markdown
-   
  foo


```

```html
<ul>
<li>foo</li>
</ul>


```

--------------------------------

### List item contents example (Example 231)

Source: https://github.github.com/gfm

Shows the lines that constitute a list item's contents. The input is a paragraph, an indented code block, and a block quote, and the output is the corresponding HTML.

```markdown
A paragraph
with two lines.

    indented code

> A block quote.

```

```html
<p>A paragraph
with two lines.</p>
<pre><code>indented code
</code></pre>
<blockquote>
<p>A block quote.</p>
</blockquote>

```

--------------------------------

### Basic block quote example

Source: https://github.github.com/gfm

Example 206: A simple block quote with markers on each line. The block quote contains a heading and a paragraph.

```markdown
> # Foo
> bar
> baz

```

```html
<blockquote>
<h1>Foo</h1>
<p>bar
baz</p>
</blockquote>

```

--------------------------------

### Example 566: Shortcut reference link

Source: https://github.github.com/gfm

A shortcut reference link [foo] is equivalent to [foo][]. The URI and title come from the definition.

```markdown
[foo]

[foo]: /url "title"

```

```html
<p><a href="/url" title="title">foo</a></p>

```

--------------------------------

### Example 350: Code span with spaces and backticks

Source: https://github.github.com/gfm

Code span with spaces and backticks.

```markdown
` foo `` bar `

```

```html
<p><code>foo `` bar</code></p>

```

--------------------------------

### Example 271: Non-lazy continuation in nested blockquote

Source: https://github.github.com/gfm

Shows the non-lazy version of the previous example, where the continuation line is prefixed with '>'. The output is identical to the lazy version.

```markdown
> 1. > Blockquote
> continued here.

```

```html
<blockquote>
<ol>
<li>
<blockquote>
<p>Blockquote
continued here.</p>
</blockquote>
</li>
</ol>
</blockquote>

```

--------------------------------

### Example 261: Empty ordered list item

Source: https://github.github.com/gfm

Shows an empty ordered list item.

```markdown
1. foo
2.
3. bar


```

```html
<ol>
<li>foo</li>
<li></li>
<li>bar</li>
</ol>


```

--------------------------------

### More than six # characters is not a heading (Example 33)

Source: https://github.github.com/gfm

A line starting with seven # characters is not parsed as a heading; it is rendered as a paragraph.

```markdown
####### foo

```

```html
<p>####### foo</p>

```

--------------------------------

### Example 506: Balanced parentheses in link destination

Source: https://github.github.com/gfm

Shows that any number of balanced parentheses are allowed without escaping in the link destination.

```markdown
[link](foo(and(bar)))

```

```html
<p><a href="foo(and(bar))">link</a></p>

```

--------------------------------

### Example 519: Whitespace around destination and title

Source: https://github.github.com/gfm

Shows that whitespace is allowed around the destination and title.

```markdown
[link](   /uri
  "title"  )

```

```html
<p><a href="/uri" title="title">link</a></p>

```

--------------------------------

### Example 521: Balanced brackets in link text

Source: https://github.github.com/gfm

Shows that the link text may contain balanced brackets.

```markdown
[link [foo [bar]]](/uri)

```

```html
<p><a href="/uri">link [foo [bar]]</a></p>

```

--------------------------------

### Example 340: Code span with only backticks

Source: https://github.github.com/gfm

Shows the motivation for stripping leading and trailing spaces.

```markdown
` `` `

```

```html
<p><code>``</code></p>

```

--------------------------------

### Empty ATX headings (Example 49)

Source: https://github.github.com/gfm

ATX headings can be empty, producing empty heading elements.

```markdown
## 
#
### ###

```

```html
<h2></h2>
<h1></h1>
<h3></h3>

```

--------------------------------

### Example 334: Entity references cannot create list markers

Source: https://github.github.com/gfm

Entity references cannot be used to create list markers; they are treated as literal text.

```markdown
&#42; foo

* foo

```

```html
<p>* foo</p>
<ul>
<li>foo</li>
</ul>

```

--------------------------------

### Example 508: Unbalanced parentheses with angle brackets

Source: https://github.github.com/gfm

Shows that unbalanced parentheses can be used in the link destination by enclosing it in angle brackets.

```markdown
[link](<foo(and(bar)>)

```

```html
<p><a href="foo(and(bar)">link</a></p>

```

--------------------------------

### Example 564: Case-insensitive collapsed reference link

Source: https://github.github.com/gfm

Link labels are case-insensitive. [Foo][] matches [foo].

```markdown
[Foo][]

[foo]: /url "title"

```

```html
<p><a href="/url" title="title">Foo</a></p>

```

--------------------------------

### Example 276: List as first block in list item

Source: https://github.github.com/gfm

Shows that a list can be the first block in a list item, creating a nested list.

```markdown
- - foo

```

```html
<ul>
<li>
<ul>
<li>foo</li>
</ul>
</li>
</ul>

```

--------------------------------

### Example 338: Simple code span

Source: https://github.github.com/gfm

A simple code span with backticks.

```markdown
`foo`

```

```html
<p><code>foo</code></p>

```

--------------------------------

### Example 3: Tab in indented code block with Unicode

Source: https://github.github.com/gfm

Shows that a tab can be used for indentation in an indented code block, and that internal tabs are passed through as literal tabs. The example includes a Unicode character (ὐ) and demonstrates that tabs are not expanded to spaces inside the code block.

```markdown
    a→a
    ὐ→a

```

```html
<pre><code>a→a
ὐ→a
</code></pre>

```

--------------------------------

### Example 347: Interior spaces not collapsed

Source: https://github.github.com/gfm

Interior spaces are not collapsed in code spans.

```markdown
`foo   bar 
baz`

```

```html
<p><code>foo   bar  baz</code></p>

```

--------------------------------

### Example 509: Escaping parentheses and other symbols

Source: https://github.github.com/gfm

Shows that parentheses and other symbols can be escaped in the link destination using backslashes.

```markdown
[link](foo\)\:)

```

```html
<p><a href="foo):">link</a></p>

```

--------------------------------

### Example 343: Unicode whitespace not stripped

Source: https://github.github.com/gfm

Only spaces, and not unicode whitespace in general, are stripped.

```markdown
` b `

```

```html
<p><code> b </code></p>

```

--------------------------------

### Optional closing sequence (Example 41)

Source: https://github.github.com/gfm

A closing sequence of # characters is optional and may be preceded by spaces.

```markdown
## foo ##
  ###   bar    ###

```

```html
<h2>foo</h2>
<h3>bar</h3>

```

--------------------------------

### Example 341: Only one space is stripped

Source: https://github.github.com/gfm

Only one space is stripped from each side when both sides have spaces.

```markdown
`  ``  `

```

```html
<p><code> `` </code></p>

```

--------------------------------

### Example 342: Stripping only when space on both sides

Source: https://github.github.com/gfm

Stripping only happens if the space is on both sides of the string.

```markdown
` a`

```

```html
<p><code> a</code></p>

```

--------------------------------

### Example 265: List item indented two spaces

Source: https://github.github.com/gfm

Shows that indenting by two spaces still produces a list item.

```markdown
  1.  A paragraph
      with two lines.

          indented code

      > A block quote.


```

```html
<ol>
<li>
<p>A paragraph
with two lines.</p>
<pre><code>indented code
</code></pre>
<blockquote>
<p>A block quote.</p>
</blockquote>
</li>
</ol>


```

--------------------------------

### Closing sequence length need not match (Example 42)

Source: https://github.github.com/gfm

The closing sequence can be longer or shorter than the opening sequence.

```markdown
# foo ##################################
##### foo ##

```

```html
<h1>foo</h1>
<h5>foo</h5>

```

--------------------------------

### Example 512: URL-escaping and entity references in destination

Source: https://github.github.com/gfm

Shows that URL-escaping is left alone and entity references are parsed into Unicode code points in the destination.

```markdown
[link](foo%20b&auml;)

```

```html
<p><a href="foo%20b%C3%A4">link</a></p>

```

--------------------------------

### Example 507: Unbalanced parentheses require escaping

Source: https://github.github.com/gfm

Shows that unbalanced parentheses in the link destination need to be escaped with backslashes.

```markdown
[link](foo\(and\(bar\))

```

```html
<p><a href="foo(and(bar)">link</a></p>

```

--------------------------------

### Example 523: Unbalanced bracket before link

Source: https://github.github.com/gfm

Shows that an unbalanced bracket before the link text causes the link to be parsed as a link.

```markdown
[link [bar](/uri)

```

```html
<p>[link <a href="/uri">bar</a></p>

```

--------------------------------

### Spaces after closing sequence allowed (Example 43)

Source: https://github.github.com/gfm

Spaces are allowed after the closing sequence of # characters.

```markdown
### foo ###     

```

```html
<h3>foo</h3>

```

--------------------------------

### Example 560: Empty link label

Source: https://github.github.com/gfm

A link label must contain at least one non-whitespace character. Here [] is not a valid label.

```markdown
[]

[]: /uri

```

```html
<p>[]</p>
<p>[]: /uri</p>

```

--------------------------------

### Example 522: Unbalanced brackets in link text

Source: https://github.github.com/gfm

Shows that unbalanced brackets in link text are not allowed and the link is not parsed.

```markdown
[link] bar](/uri)

```

```html
<p>[link] bar](/uri)</p>

```

--------------------------------

### Example 328: Entity references in link destination and title

Source: https://github.github.com/gfm

Entity references are recognized in link destinations and titles.

```markdown
[foo](/f&ouml;&ouml; "f&ouml;&ouml;")

```

```html
<p><a href="/f%C3%B6%C3%B6" title="föö">foo</a></p>

```

--------------------------------

### Markdown.pl paragraph interruption example

Source: https://github.github.com/gfm

Shows a hard-wrapped line that Markdown.pl does not treat as a list, illustrating a difference from CommonMark.

```markdown
The number of windows in my house is
14.  The number of doors is 6.

```

--------------------------------

### Example 85: Indented code before and after other blocks

Source: https://github.github.com/gfm

Indented code can appear immediately before and after headings and thematic breaks.

```markdown
# Heading
    foo
Heading
------
    foo
----

```

```html
<h1>Heading</h1>
<pre><code>foo
</code></pre>
<h2>Heading</h2>
<pre><code>foo
</code></pre>
<hr />

```

--------------------------------

### Simple ATX headings (Example 32)

Source: https://github.github.com/gfm

Shows headings from level 1 to 6. Each opening sequence is followed by a space and the heading content is 'foo'.

```markdown
# foo
## foo
### foo
#### foo
##### foo
###### foo

```

```html
<h1>foo</h1>
<h2>foo</h2>
<h3>foo</h3>
<h4>foo</h4>
<h5>foo</h5>
<h6>foo</h6>

```

--------------------------------

### CommonMark list interruption example

Source: https://github.github.com/gfm

Shows a natural list interruption without blank lines, which CommonMark allows.

```markdown
I need to buy
- new shoes
- a coat
- a plane ticket

```

--------------------------------

### Example 562: Collapsed reference link

Source: https://github.github.com/gfm

A collapsed reference link [foo][] is equivalent to [foo][foo]. The URI and title come from the definition.

```markdown
[foo][]

[foo]: /url "title"

```

```html
<p><a href="/url" title="title">foo</a></p>

```

--------------------------------

### Example 266: List item indented three spaces

Source: https://github.github.com/gfm

Shows that indenting by three spaces still produces a list item.

```markdown
   1.  A paragraph
       with two lines.

           indented code

       > A block quote.


```

```html
<ol>
<li>
<p>A paragraph
with two lines.</p>
<pre><code>indented code
</code></pre>
<blockquote>
<p>A block quote.</p>
</blockquote>
</li>
</ol>


```

--------------------------------

### Example 513: Title parsed as destination

Source: https://github.github.com/gfm

Shows that if you omit the destination and keep the title, the title is parsed as the destination.

```markdown
[link]("title")

```

```html
<p><a href="%22title%22">link</a></p>

```

--------------------------------

### Changing bullet delimiter starts a new list (Example 281)

Source: https://github.github.com/gfm

Shows that changing the bullet character from '-' to '+' starts a new list. The HTML output contains two separate <ul> elements.

```markdown
- foo
- bar
+ baz

```

```html
<ul>
<li>foo</li>
<li>bar</li>
</ul>
<ul>
<li>baz</li>
</ul>

```

--------------------------------

### Example 520: Whitespace between link text and parenthesis

Source: https://github.github.com/gfm

Shows that whitespace is not allowed between the link text and the following parenthesis.

```markdown
[link] (/uri)

```

```html
<p>[link] (/uri)</p>

```

--------------------------------

### Closing sequence must be preceded by space (Example 45)

Source: https://github.github.com/gfm

Without a space before the closing #, the # is part of the heading content.

```markdown
# foo#

```

```html
<h1>foo#</h1>

```

--------------------------------

### Example 515: Escapes and references in titles

Source: https://github.github.com/gfm

Shows that backslash escapes and entity references may be used in titles.

```markdown
[link](/url "title \"&quot;")

```

```html
<p><a href="/url" title="title &quot;&quot;">link</a></p>

```

--------------------------------

### Example 268: Lazy continuation lines

Source: https://github.github.com/gfm

Shows that deleting indentation from some lines (lazy continuation) still produces a list item.

```markdown
  1.  A paragraph
with two lines.

          indented code

      > A block quote.


```

```html
<ol>
<li>
<p>A paragraph
with two lines.</p>
<pre><code>indented code
</code></pre>
<blockquote>
<p>A block quote.</p>
</blockquote>
</li>
</ol>


```

--------------------------------

### Table with no body rows

Source: https://github.github.com/gfm

Example 205: A table with only a header row and no body rows. The HTML output does not generate a <tbody> element.

```markdown
| abc | def |
| --- | --- |

```

```html
<table>
<thead>
<tr>
<th>abc</th>
<th>def</th>
</tr>
</thead>
</table>

```

--------------------------------

### Example 554: Matching on normalized strings

Source: https://github.github.com/gfm

Matching is performed on normalized strings, not parsed inline content. The label [foo!] does not match [foo\!].

```markdown
[bar][foo\!]

[foo!]: /url

```

```html
<p>[bar][foo!]</p>

```

--------------------------------

### Example 572: Backslash-escape opening bracket to avoid links

Source: https://github.github.com/gfm

To get bracketed text without a link, backslash-escape the opening bracket. Here \[foo] is not a link.

```markdown
\[foo]

[foo]: /url "title"

```

--------------------------------

### Example 260: Empty bullet list item with spaces

Source: https://github.github.com/gfm

Shows that spaces following the list marker do not affect the empty list item.

```markdown
- foo
-   
- bar


```

```html
<ul>
<li>foo</li>
<li></li>
<li>bar</li>
</ul>


```

--------------------------------

### AsciiDoc list example with nested blocks

Source: https://github.github.com/gfm

A sample from the AsciiDoc manual showing a numbered list with continuation paragraphs, an indented block, and an open block. It demonstrates AsciiDoc's explicit continuation markers and block delimiters.

```asciidoc
1. List item one.
+
List item one continued with a second paragraph followed by an
Indented block.
+
.................
$ ls *.sh
$ mv *.sh ~/tmp
.................
+
List item continued with a third paragraph.

2. List item two continued with an open block.
+
--
This paragraph is part of the preceding list item.

a. This list is nested and does not require explicit item
continuation.
+
This paragraph is part of the preceding list item.

b. List item b.

This paragraph belongs to item two of the outer list.
--

```

--------------------------------

### Example 259: Empty bullet list item

Source: https://github.github.com/gfm

Shows an empty bullet list item in the middle of a list.

```markdown
- foo
-
- bar


```

```html
<ul>
<li>foo</li>
<li></li>
<li>bar</li>
</ul>


```

--------------------------------

### Inline content in ATX headings (Example 36)

Source: https://github.github.com/gfm

Heading contents are parsed as inline content, so emphasis and escaped characters are processed.

```markdown
# foo *bar* \*baz\*

```

```html
<h1>foo <em>bar</em> *baz*</h1>

```

--------------------------------

### Block quote with lazy continuation and indented list

Source: https://github.github.com/gfm

Example 216: A lazy continuation line that is indented too far to start a list becomes paragraph continuation text. The output shows a paragraph with a list item.

```markdown
> foo
    - bar

```

```html
<blockquote>
<p>foo
- bar</p>
</blockquote>

```

--------------------------------

### Example 77: Basic indented code block

Source: https://github.github.com/gfm

Shows a simple indented code block with four spaces of indentation removed from each line.

```markdown
    a simple
      indented code block

```

```html
<pre><code>a simple
  indented code block
</code></pre>

```

--------------------------------

### HTML block with nested pre (Example 118)

Source: https://github.github.com/gfm

Shows that HTML within an HTML block is passed through as-is. The block started by `<table>` ends at a blank line, so the `<pre>` inside does not affect the parser state.

```html
<table><tr><td>
<pre>
**Hello**,

_world_.
</pre>
</td></tr></table>
```

```html
<table><tr><td>
<pre>
**Hello**,
<p><em>world</em>.
</pre></p>
</td></tr></table>
```

--------------------------------

### Run Markdown spec tests with spec_tests.py

Source: https://github.github.com/gfm

Use this command to run the conformance tests against any Markdown program. Replace PROGRAM with the path or command for your Markdown implementation.

```bash
python test/spec_tests.py --spec spec.txt --program PROGRAM

```

--------------------------------

### Example 571: Space after link text preserved

Source: https://github.github.com/gfm

A space after the link text is preserved. Here [foo] bar produces a link followed by a space and text.

```markdown
[foo] bar

[foo]: /url

```

```html
<p><a href="/url">foo</a> bar</p>

```

--------------------------------

### Consecutive block quotes become one (Example 221)

Source: https://github.github.com/gfm

Shows that consecutive block quotes without a blank line are merged into a single block quote. The input has two lines each starting with '>', and the output is one blockquote with a paragraph containing both lines.

```markdown
> foo
> bar

```

```html
<blockquote>
<p>foo
bar</p>
</blockquote>

```

--------------------------------

### Example 258: List item with at most one blank line

Source: https://github.github.com/gfm

Shows that a list item can begin with at most one blank line; 'foo' is not part of the list item.

```markdown
-

  foo


```

```html
<ul>
<li></li>
</ul>
<p>foo</p>


```

--------------------------------

### Example 6: Tab after block quote marker

Source: https://github.github.com/gfm

Shows that a tab after a block quote marker is treated as if expanded into three spaces, making the content indented six spaces inside the block quote context, resulting in an indented code block starting with two spaces. The output is an HTML blockquote with a pre/code block.

```markdown
>→→foo

```

```html
<blockquote>
<pre><code>  foo
</code></pre>
</blockquote>

```

--------------------------------

### Markdown equivalent list example

Source: https://github.github.com/gfm

The equivalent Markdown version of the AsciiDoc sample, using indentation to nest list items and blocks. It illustrates Markdown's readability advantage, as nesting is visually apparent in the source.

```markdown
1.  List item one.

    List item one continued with a second paragraph followed by an
    Indented block.

        $ ls *.sh
        $ mv *.sh ~/tmp

    List item continued with a third paragraph.

2.  List item two continued with an open block.

    This paragraph is part of the preceding list item.

    1. This list is nested and does not require explicit item continuation.

       This paragraph is part of the preceding list item.

    2. List item b.

    This paragraph belongs to item two of the outer list.

```

--------------------------------

### End tag on same line as start tag

Source: https://github.github.com/gfm

Shows an HTML block (style) where the end tag is on the same line as the start tag. The following '*foo*' is rendered as emphasis.

```markdown
<style>p{color:red;}</style>
*foo*

```

```html
<style>p{color:red;}</style>
<p><em>foo</em></p>

```

--------------------------------

### Example 567: Shortcut reference link with inline content

Source: https://github.github.com/gfm

The contents of the first link label are parsed as inlines. Here [*foo* bar] produces emphasized text.

```markdown
[*foo* bar]

[*foo* bar]: /url "title"

```

```html
<p><a href="/url" title="title"><em>foo</em> bar</a></p>

```

--------------------------------

### Example 273: One-space indent is not enough

Source: https://github.github.com/gfm

Shows that one space of indentation is not enough to create a sublist; the items become siblings instead of nested.

```markdown
- foo
 - bar
  - baz
   - boo

```

```html
<ul>
<li>foo</li>
<li>bar</li>
<li>baz</li>
<li>boo</li>
</ul>

```

--------------------------------

### Example 333: Entity references cannot be used for structure

Source: https://github.github.com/gfm

Entity references cannot be used in place of symbols indicating structure; they are treated as literal text.

```markdown
&#42;foo&#42;
*foo*

```

```html
<p>*foo*
<em>foo</em></p>

```

--------------------------------

### Example 81: Multiple chunks separated by blank lines

Source: https://github.github.com/gfm

Blank lines between indented chunks are preserved in the code block content.

```markdown
    chunk1

    chunk2
  
 
 
    chunk3

```

```html
<pre><code>chunk1

chunk2



chunk3
</code></pre>

```

--------------------------------

### Example 553: First matching definition is used

Source: https://github.github.com/gfm

When multiple link reference definitions match, the first one is used. Here [bar][foo] resolves to /url1.

```markdown
[foo]: /url1

[foo]: /url2

[bar][foo]

```

```html
<p><a href="/url1">bar</a></p>

```

--------------------------------

### Example 275: Three-space indent is not enough for wider marker

Source: https://github.github.com/gfm

Shows that three spaces are not enough to create a sublist when the marker is wider; the sublist becomes a separate list.

```markdown
10) foo
   - bar

```

```html
<ol start="10">
<li>foo</li>
</ol>
<ul>
<li>bar</li>
</ul>

```

--------------------------------

### Example 552: Newline between link text and label

Source: https://github.github.com/gfm

Shows that a newline between link text and label is also not allowed. The link [foo] and [bar] are separate.

```markdown
[foo]
[bar]

[bar]: /url "title"

```

```html
<p>[foo]
<a href="/url" title="title">bar</a></p>

```

--------------------------------

### Example 569: Shortcut reference link with unmatched bracket

Source: https://github.github.com/gfm

Shows that an unmatched bracket prevents a shortcut reference link. Here [[bar [foo] is parsed as text and a link.

```markdown
[[bar [foo]

[foo]: /url

```

```html
<p>[[bar <a href="/url">foo</a></p>

```

--------------------------------

### Example 504: Unmatched pointy brackets in link destinations

Source: https://github.github.com/gfm

Shows that pointy brackets in link destinations are not treated as links when the opening bracket is not matched properly. The input and output are displayed as fenced code blocks.

```markdown
[a](<b)c
[a](<b)c>
[a](<b>c)

```

```html
<p>[a](&lt;b)c
[a](&lt;b)c&gt;
[a](<b>c)</p>

```

--------------------------------

### Example 524: Escaped bracket in link text

Source: https://github.github.com/gfm

Shows that unbalanced brackets can be escaped with a backslash.

```markdown
[link \[bar](/uri)

```

```html
<p><a href="/uri">link [bar</a></p>

```

--------------------------------

### Example 274: Sublist with four-space indent for wider marker

Source: https://github.github.com/gfm

Shows that when the list marker is wider (e.g., '10)'), four spaces are needed to create a sublist.

```markdown
10) foo
    - bar

```

```html
<ol start="10">
<li>foo
<ul>
<li>bar</li>
</ul>
</li>
</ol>

```

--------------------------------

### Example 568: Shortcut reference link inside brackets

Source: https://github.github.com/gfm

Shows that a shortcut reference link can be nested inside brackets. Here [[*foo* bar]] produces a link inside brackets.

```markdown
[[*foo* bar]]

[*foo* bar]: /url "title"

```

```html
<p>[<a href="/url" title="title"><em>foo</em> bar</a>]</p>

```

--------------------------------

### Example 255: List item with fenced code block and indented continuation

Source: https://github.github.com/gfm

Shows that removing 1-3 spaces of indentation allows rule #1 to be applied, forming a list item with a fenced code block.

```markdown
-  foo

   bar


```

```html
<ul>
<li>
<p>foo</p>
<p>bar</p>
</li>
</ul>


```

--------------------------------

### Escaped # is not a heading (Example 35)

Source: https://github.github.com/gfm

When the first # is backslash-escaped, the line is not a heading and the backslash is removed in the output.

```markdown
\## foo

```

```html
<p>## foo</p>

```

--------------------------------

### Fenced code block with empty info string (Example 114)

Source: https://github.github.com/gfm

Shows that an info string can be empty, resulting in a `language-` class with no language name.

```markdown
````;
````
```

```html
<pre><code class="language-;"></code></pre>
```

--------------------------------

### Example 511: Backslash before non-escapable character

Source: https://github.github.com/gfm

Shows that a backslash before a non-escapable character is just a backslash and is URL-encoded in the output.

```markdown
[link](foo\bar)

```

```html
<p><a href="foo%5Cbar">link</a></p>

```

--------------------------------

### Example 344: No stripping for code spans with only spaces

Source: https://github.github.com/gfm

No stripping occurs if the code span contains only spaces.

```markdown
` `
`  `

```

```html
<p><code> </code>
<code>  </code></p>

```

--------------------------------

### Example 327: Entity references in URLs

Source: https://github.github.com/gfm

Entity references are recognized in URLs, as shown in an HTML attribute.

```html
<a href="&ouml;&ouml;.html">

```

```html
<a href="&ouml;&ouml;.html">

```

--------------------------------

### Example 73: Multiline heading with blank line after first paragraph

Source: https://github.github.com/gfm

Shows that a blank line after the first paragraph prevents the setext heading underline from applying to it, resulting in a paragraph followed by a heading.

```markdown
Foo

bar
---
baz

```

```html
<p>Foo</p>
<h2>bar</h2>
<p>baz</p>

```

--------------------------------

### Empty block quote

Source: https://github.github.com/gfm

Example 217: A block quote can be empty. The output is an empty <blockquote> element.

```markdown
>

```

```html
<blockquote>
</blockquote>

```

--------------------------------

### Example 563: Collapsed reference link with inline content

Source: https://github.github.com/gfm

The contents of the first link label are parsed as inlines. Here [*foo* bar][] produces emphasized text.

```markdown
[*foo* bar][]

[*foo* bar]: /url "title"

```

```html
<p><a href="/url" title="title"><em>foo</em> bar</a></p>

```

--------------------------------

### Example 254: List item with fenced code block and blank line

Source: https://github.github.com/gfm

Demonstrates that a fenced code block inside a list item with a blank line is not part of the list item.

```markdown
-    foo

  bar


```

```html
<ul>
<li>foo</li>
</ul>
<p>bar</p>


```

--------------------------------

### Example 278: List item containing heading and setext heading

Source: https://github.github.com/gfm

Shows that a list item can contain a heading, including a setext heading with '---'.

```markdown
- # Foo
- Bar
  ---
  baz

```

```html
<ul>
<li>
<h1>Foo</h1>
</li>
<li>
<h2>Bar</h2>
baz</li>
</ul>

```

--------------------------------

### Example 517: Nested balanced quotes not allowed

Source: https://github.github.com/gfm

Shows that nested balanced quotes are not allowed without escaping.

```markdown
[link](/url "title "and" title")

```

```html
<p>[link](/url &quot;title &quot;and&quot; title&quot;)</p>

```

--------------------------------

### Example 346: Trailing spaces preserved

Source: https://github.github.com/gfm

Line endings are treated like spaces, but trailing spaces are preserved.

```markdown
``
foo 
``

```

```html
<p><code>foo </code></p>

```

--------------------------------

### Closing code fence with info string (Example 117)

Source: https://github.github.com/gfm

Shows that closing code fences cannot have info strings. The closing fence with `aaa` is treated as content, not as a closing fence.

```markdown
```
``` aaa
```
```

```html
<pre><code>``` aaa
</code></pre>
```

--------------------------------

### Example 345: Line endings treated as spaces

Source: https://github.github.com/gfm

Line endings are treated like spaces in code spans.

```markdown
``
foo
bar  
baz
``

```

```html
<p><code>foo bar   baz</code></p>

```

--------------------------------

### Example 329: Entity references in reference link definitions

Source: https://github.github.com/gfm

Entity references are recognized in reference link definitions.

```markdown
[foo]

[foo]: /f&ouml;&ouml; "f&ouml;&ouml;"

```

```html
<p><a href="/f%C3%B6%C3%B6" title="föö">foo</a></p>

```

--------------------------------

### One to three spaces indentation allowed (Example 38)

Source: https://github.github.com/gfm

ATX headings may be indented 0-3 spaces. The indentation is not part of the heading content.

```markdown
 ### foo
  ## foo
   # foo

```

```html
<h3>foo</h3>
<h2>foo</h2>
<h1>foo</h1>

```

--------------------------------

### Example 326: Made-up entity not recognized

Source: https://github.github.com/gfm

Strings not on the HTML5 named entities list are not recognized as entity references.

```markdown
&MadeUpEntity;

```

```html
<p>&amp;MadeUpEntity;</p>

```

--------------------------------

### Example 263: Empty list item cannot interrupt paragraph

Source: https://github.github.com/gfm

Shows that an empty list item cannot interrupt a paragraph.

```markdown
foo
*

foo
1.


```

```html
<p>foo
*</p>
<p>foo
1.</p>


```

--------------------------------

### ATX heading interrupts paragraph (Example 48)

Source: https://github.github.com/gfm

A heading can interrupt a paragraph, splitting it into separate paragraphs before and after the heading.

```markdown
Foo bar
# baz
Bar foo

```

```html
<p>Foo bar</p>
<h1>baz</h1>
<p>Bar foo</p>

```

--------------------------------

### Backslash-escaped # in closing sequence (Example 46)

Source: https://github.github.com/gfm

Backslash-escaped # characters do not count as part of the closing sequence and are rendered as literal #.

```markdown
### foo \###
## foo #\##
# foo \#

```

```html
<h3>foo ###</h3>
<h2>foo ###</h2>
<h1>foo #</h1>

```

--------------------------------

### Example 5: Two tabs in continuation of list item

Source: https://github.github.com/gfm

Shows that two tabs used to indent a continuation of a list item are treated as if expanded to eight spaces, resulting in an indented code block inside the list item. The output is an HTML ul/li with a pre/code block containing two spaces before 'bar'.

```markdown
- foo

→→bar

```

```html
<ul>
<li>
<p>foo</p>
<pre><code>  bar
</code></pre>
</li>
</ul>

```

--------------------------------

### Example 2: Tab with two leading spaces in indented code block

Source: https://github.github.com/gfm

Shows that two spaces followed by a tab in an indented code block is equivalent to four spaces of indentation. The tab is treated as if expanded to four spaces, so the content is still an indented code block. The output is an HTML pre/code block with the literal tab.

```markdown
  →foo→baz→→bim

```

```html
<pre><code>foo→baz→→bim
</code></pre>

```

--------------------------------

### Example 559: Backslash in link label

Source: https://github.github.com/gfm

Shows that a backslash before a closing bracket is not escaped. The label [bar\\] matches the definition.

```markdown
[bar\\]: /uri

[bar\\]

```

```html
<p><a href="/uri">bar\</a></p>

```

--------------------------------

### Example 558: Escaped bracket in link label

Source: https://github.github.com/gfm

Backslash-escaped brackets are allowed in link labels. Here [ref\[] matches the definition.

```markdown
[foo][ref\[]

[ref\[]: /uri

```

```html
<p><a href="/uri">foo</a></p>

```

--------------------------------

### Example 514: Title quote styles

Source: https://github.github.com/gfm

Shows that titles may be enclosed in single quotes, double quotes, or parentheses.

```markdown
[link](/url "title")
[link](/url 'title')
[link](/url (title))

```

```html
<p><a href="/url" title="title">link</a>
<a href="/url" title="title">link</a>
<a href="/url" title="title">link</a></p>

```

--------------------------------

### Example 10: Tab after ATX heading marker

Source: https://github.github.com/gfm

Shows that a tab after the '#' marker of an ATX heading is treated as if expanded to four spaces, so the heading content is 'Foo'. The output is an HTML h1 element.

```markdown
#→Foo

```

```html
<h1>Foo</h1>

```

--------------------------------

### Example 331: Entity references in code spans are literal

Source: https://github.github.com/gfm

Entity references are treated as literal text in code spans.

```markdown
`f&ouml;&ouml;`

```

```html
<p><code>f&amp;ouml;&amp;ouml;</code></p>

```

--------------------------------

### Example 79: Nested list item interpretation

Source: https://github.github.com/gfm

Indentation is interpreted as a nested list item rather than a code block.

```markdown
1.  foo

    - bar

```

```html
<ol>
<li>
<p>foo</p>
<ul>
<li>bar</li>
</ul>
</li>
</ol>

```
Tokens:
Raw