Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adds aliases for heading types #519

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

adds aliases for heading types #519

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions spec.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -749,7 +749,7 @@ If you want a thematic break in a list item, use a different bullet:

## ATX headings

An [ATX heading](@)
An [ATX heading](@) or [prefixed heading](@)
consists of a string of characters, parsed as inline content, between an
opening sequence of 1--6 unescaped `#` characters and an optional
closing sequence of any number of unescaped `#` characters.
Expand Down Expand Up @@ -968,10 +968,14 @@ ATX headings can be empty:
<h3></h3>
````````````````````````````````

Note that MediaWiki markup uses the equals sign `=` for ATX-like headings instead
and uses the number sign `#` for ordered list items.
This constitutes one major incompatibility between CommonMark and MediaWiki.


## Setext headings

A [setext heading](@) consists of one or more
A [setext heading](@) or [underlined 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
Expand All @@ -983,9 +987,9 @@ interpretable as a [code fence], [ATX heading][ATX headings],

A [setext heading underline](@) is a sequence of
`=` 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
spaces indentation and any number of trailing spaces.
If a line containing a single `-` can be interpreted as an
empty [list item][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
Expand Down Expand Up @@ -1307,6 +1311,11 @@ One can find four different interpretations:
3. paragraph "Foo bar --- baz"
4. heading "Foo bar", paragraph "baz"

Interpretation 3 does not comply with the CommonMark rule
that both a [thematic break] and a setext heading
can interrupt a paragraph,
i.e. they do not need a blank line before or after.

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
Expand Down Expand Up @@ -1588,7 +1597,7 @@ spaces and called the [info string](@).
The [info string] may not contain any backtick
characters. (The reason for this restriction is that otherwise
some inline code would be incorrectly interpreted as the
beginning of a fenced code block.)
beginning of a fenced code block.)

The content of the code block consists of all subsequent lines, until
a closing [code fence] of the same type as the code block
Expand Down