Should <h4> tags get direct linkified?
See original GitHub issueI see that the heading-highlight implementation stops after <h3>
. I remember when this utility was implemented but I can’t immediately think of a reason why we didn’t choose to highlight past <h3>
.
I bring this up because sometimes when including links in a blog post (or sharing them), we might be referencing the same page in a single paragraph or even in the same sentence. So if I’m providing a link to https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes#field_declarations for example and then want to show the private field declarations the only direct link I have is ..#field_declarations
which doesn’t take me directly to the desired subheading. This isn’t a problem, but more a question. I can foresee it looking a bit wonky with so many links, but I want to be able to replace this (which uses the same subheading direct link as the <h4>
tags are linkified):
I am writing about Field declarations in JavaScript and also Private field declarations but want the private field declarations to directly link to that subheading within field declarations.
with this (where the private field declarations link will directly link to that subheading /Classes#private_field_declarations
rather than having to scroll down a bit from field declarations and providing two of the same subheading links with /Classes#field_declarations
:
I am writing about Field declarations in JavaScript and also Private field declarations and both links are unique linking to the specified subheading.
As a developer its pretty easy to open devtools and grab the id and replace the last component of the URL with the desired ID (to create your own direct link) but this isn’t always ideal.
What do you think about <h4>
tags getting direct linkified? @peterbe
Issue Analytics
- State:
- Created 2 years ago
- Reactions:1
- Comments:8 (7 by maintainers)
It certainly would be nice! I’ve many times found that there’s a specific portion of the page I’d like to link to but the nearest h2/h3 is so far away/up that the anchor link doesn’t make much sense. I’d have to say “Go to the link Examples section and scroll down down to the section about polyfills”.
But we’d have to be a bit careful. Perhaps
h4
s aren’t as neatly used. It might be on the Tier 1 docs (i.e. popular en-US JS and CSS docs) but not on the long tail. Perhaps worth a shot and see how it feels and behaves. But we would need to browser a lot of samples to make sure it works OK.For example, you can’t have HTML within a
h2
orh3
because the whole heading becomes a link. So if you had:it will become:
Also, I don’t remember what does Yari do when there’s a
<h3>
that doesn’t have an ID? I think the kumascript rendering automatically generates on making<h3>Foo bar</h3>
into<h3 id="foo-bar">Foo bar</h3>
, first. But that’d need to be applied to allh4
too.