Flexmark and pegdown differ in their treatment of setext headings. Flexmark makes such headings an anchor regardless of inline formatting, while pegdown does not when there is inline formatting.
A setext heading consists of one or more lines of text, each containing at least one [non-whitespace character], with no more than 3 spaces indentation, followed by a [setext heading underline]. The lines of text must be such that, were they not followed by the setext heading underline, they would be interpreted as a paragraph: they cannot be interpretable as a [code fence], [ATX heading][ATX headings], [block quote][block quotes], [thematic break][thematic breaks], [list item][list items], or [HTML block][HTML blocks].
A setext heading underline is a sequence of at least 3 = characters or a sequence of - characters, with no more than 3 spaces indentation and any number of trailing spaces. If a line containing a single - can be interpreted as an empty [list items], it should be interpreted this way and not as a [setext heading underline].
The heading is a level 1 heading if = characters are used in the [setext heading underline], and a level 2 heading if - characters are used. The contents of the heading are the result of parsing the preceding lines of text as inline content.
In general, a setext heading need not be preceded or followed by a blank line. However, it cannot interrupt a paragraph, so when a setext heading comes after a paragraph, a blank line is needed between them.
Simple examples:
Example extra - number of underline characters
```
Foobar
=
Foobar
==
Foobar
===
```
Foobar =
Foobar ==
Example 50 - headings with emphasis (differ in flexmark vs. pegdown)
```
Foo *bar*
=========
Foo *bar*
---------
```
The content of the header may span more than one line in flexmark, but not in pegdown:
Example 51 - two-line header
```
Foo bar
baz
====
```
Foo bar
The underlining can be any length > 3:
Example 52 - long and short underlining
```
Foo
-------------------------
Foo
=====
```
The heading content can be indented up to three spaces, and need not line up with the underlining. However, there can be no spaces preceding the underlining.
Example 53 - spaces in heading content
```
Foo
---
Foo
-----
Foo
===
Foo
===
Foo
===
```
Foo ===
Foo ===
Four spaces indent for content is too much:
```
Foo
---
```
Foo
The setext heading underline may have trailing spaces:
```
Foo
----
```
The setext heading underline cannot contain internal spaces:
```
Foo
=== =
Foo
--- -
```
Foo === =
Foo — -
Trailing spaces in the content line do not cause a line break:
Foo
-----
.
<h2>Foo</h2>
Nor does a backslash at the end:
Foo\
----
.
<h2>Foo\</h2>
Since indicators of block structure take precedence over indicators of inline structure, the following are setext headings:
`Foo
----
`
<a title="a lot
---
of dashes"/>
.
<h2>`Foo</h2>
<p>`</p>
<h2><a title="a lot</h2>
<p>of dashes"/></p>
The setext heading underline cannot be a [lazy continuation line] in a list item or block quote:
> Foo
---
.
<blockquote>
<p>Foo</p>
</blockquote>
<hr />
> foo
bar
===
.
<blockquote>
<p>foo
bar
===</p>
</blockquote>
- Foo
---
.
<ul>
<li>Foo</li>
</ul>
<hr />
A blank line is needed between a paragraph and a following setext heading, since otherwise the paragraph becomes part of the heading’s content:
Foo
Bar
---
.
<h2>Foo
Bar</h2>
But in general a blank line is not required before or after setext headings:
Baz .
Baz
Setext headings cannot be empty:
==== .
====
Setext heading text lines must not be interpretable as block
constructs other than paragraphs. So, the line of dashes
in these examples gets interpreted as a thematic break:
.
```````````````````````````````` example
- foo
-----
.
<ul>
<li>foo</li>
</ul>
<hr />
foo
---
.
<pre><code>foo
</code></pre>
<hr />
> foo
-----
.
<blockquote>
<p>foo</p>
</blockquote>
<hr />
If you want a heading with > foo as its literal text, you can use backslash escapes:
\> foo
------
.
<h2>> foo</h2>
Compatibility note: Most existing Markdown implementations do not allow the text of setext headings to span multiple lines. But there is no consensus about how to interpret
Foo
bar
---
baz
One can find four different interpretations:
We find interpretation 4 most natural, and interpretation 4 increases the expressive power of CommonMark, by allowing multiline headings. Authors who want interpretation 1 can put a blank line after the first paragraph:
Foo
bar
---
baz
.
<p>Foo</p>
<h2>bar</h2>
<p>baz</p>
Authors who want interpretation 2 can put blank lines around the thematic break,
Foo
bar
---
baz
.
<p>Foo
bar</p>
<hr />
<p>baz</p>
or use a thematic break that cannot count as a [setext heading underline], such as
Foo
bar
* * *
baz
.
<p>Foo
bar</p>
<hr />
<p>baz</p>
Authors who want interpretation 3 can use backslash escapes:
Foo
bar
\---
baz
.
<p>Foo
bar
---
baz</p>