Make headings clickable for #anchored URLs

[Fang-]

A lot of our docs pages are fairly long and have multiple sections. Often, I want to link someone to a specific part of the page. We support /some/page#anchor behavior for most of our headings, but having to append that manually (and sometimes, figuring out the right anchor text to use) it a bit burdensome. It would be great if we could click headers, or a 🖇 next to them, to navigate to its #anchor on the page. Similar to how Github allows you to do in readme's and other .md files.

[matildepark]

This is an easy addition but I’m curious about the best design for it.

…

Sent from my iPhone

On Nov 15, 2019, at 9:52 AM, Fang ***@***.***> wrote:  A lot of our docs pages are fairly long and have multiple sections. Often, I want to link someone to a specific part of the page. We support /some/page#anchor behavior for most of our headings, but having to append that manually (and sometimes, figuring out the right anchor text to use) it a bit burdensome. It would be great if we could click headers, or a 🖇 next to them, to navigate to its #anchor on the page. Similar to how Github allows you to do in readme's and other .md files. — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or unsubscribe.

[Fang-]

I'd say making them invisibly clickable is fine. Expected behavior here (as per GH's implementation) is that there's a visual indicator on-hover, and just the clickable-cursor might suffice.

(But I'm not Design Team, which should probably still weigh in.)

[ynx0]

I was missing this feature as well. I think that readthedocs.io does this well, where they show a some sort of symbol next to the title on hover, along with some alt-text saying something like "Permalink to this headline". I have seen a pilcrow and a chain (to symbolize a link) being used.

• Example with chain
  

• Example with pilcrow
  

[tylershuster]

https://www.getzola.org/documentation/content/linking/#anchor-insertion

[ynx0]

I decided to try my hand at it and created a draft pr (#551). Please let me know what you think.

[ynx0]

I think #551 resolves this.

[Fang-]

Doesn't look like #551 affected the getting started section of the docs, but otherwise, hurray!

[ynx0]

Oh yeah, that's cause I didn't know which parts of the docs to enable them so I just did a couple of them that made sense at the time... Enabling/disabling can be done with the anchors.py script.