jgarber / redcloth

RedCloth is a Ruby library for converting Textile into HTML.
Other
443 stars 113 forks source link

Skipping heading ranks #56

Closed ghost closed 4 years ago

ghost commented 5 years ago

With Asciidoc, it is recommended to keep headings in order. That is to say, H4 should not follow H2, better for H3 to follow H2. If you break this it gives a warning:

asciidoctor: WARNING: readme.adoc: line 11: section title out of sequence:
expected level 2, got level 3

i was somewhat surprised by this, but then i noticed this is an official recommendation as well:

RedCloth has no restriction on header order and in fact doesnt even advise against out of order headings:

https://promptworks.com/textile/page-layout#headings