Bootstrap: Nav Document Outline

[chrisbo]

Noticed in the nav examples that <h6> is being used for a dropdown header which gives a nav document outline of

Thoughts?

[andresgalante]

Hi @chrisbo I couldn't find it here: http://getbootstrap.com/docs/4.0/examples/navbars/

Can you send me the URL where you found it please?

[mdo]

There's an <h6> in our dropdowns.md file @andresgalante. I'm unsure what the screenshot is from, but it seems to be unrelated to our code :).

[chrisbo]

@andresgalante It's been a while and I can't recall where I found it. The screenshot was just a simplified example I made up.

[chrisbo]

@andresgalante Just bumped into an example in the documentation:

https://getbootstrap.com/docs/4.0/components/dropdowns/#menu-headers

An <h6> shouldn't be used for styling.

[XhmikosR]

PRs welcome to tweak the docs.

[avikranj1]

As per my knowledge normally we do not use h6 for styling headline or even nav dropdown. But it depends on the designer.

[XhmikosR]

What should we do about callouts though?

/CC @patrickhlauke

[XhmikosR]

Ok I made a branch. While there are some good cases this can be fixed, there are others, namely some examples, that this will cause an extra class.

Also, the current ToC plugin will include some of the new headers. This will be fixed when we switch to Hugo though.

I'm not sure how to proceed.

/CC @mdo for thoughts.

[patrickhlauke]

as mentioned before, having heading level gaps is not ideal...but nobody really dies from that. if we can't rewrite heading levels on the fly for things that get included (callouts) to have the appropriate level, then having those at <h6> is the lesser evil (it would at least guarantee they're always subordinate to whatever heading comes hierarchically above it/the section they're in, assuming those only go to <h5> at the most)

[edit: but yes, for stuff that we control directly, like examples, it makes sense to make the heading levels follow a sane hierarchy with no gaps in levels]

[XhmikosR]

I'm actually more concerned about the examples. See the above diff.

[patrickhlauke]

this is where the semantics of HTML aren't quite sufficiently expressive...you'd really want to be able to somehow demarcate those example bits of code as something that doesn't really pertain to the overall page structure...

but, as that's not possible, i'd say those are fine as per the diff. Once these don't show up in the TOCs either, it's probably as good as they can be made...

[XhmikosR]

@patrickhlauke do we close this one?

[patrickhlauke]

yup, i'd say close