jirutka / asciidoctor-html5s

Semantic HTML5 converter (backend) for Asciidoctor
MIT License
89 stars 10 forks source link

Are h6 titles actually desired? #25

Open toastal opened 1 year ago

toastal commented 1 year ago

One thing I liked about the about titles from OG AsciiDoc is that titles can be used more like an annotation rather than needing to be a physical <h*> heading. What this means is that it this title does not become a part of the document outline. If I wanted a heading like that I would have used ======. According to the spec, headings like this seem to be a suggestion and not a requirement as there are a lot of sections that don't need this type of outlining header. However, I'm actively willing be told this is a bad assumption about browsers and other readers perceive the document, as well as better understand the HTML spec. To me, it seems like maybe <header> makes more sense without any specified <h*> as it's not a requirement and isn't treated as a part of the outline, but not entirely sure.