Add direct (visible) anchor links on each of the headings and subheadings #1214
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
https://www.bryanbraun.com/anchorjs/ AnchorJS is under the MIT license. This bundle is direct from: https://github.com/bryanbraun/anchorjs/blob/14e912226316aea775d957fa96c295193157f31d/anchor.min.js Doesn't seem much point in messing with NPM for this, it is a small and fairly simple script. (I unminfied and checked for signs of malicious content, it seems fine)
The standard library gets some extra attention here, to put anchor links onto each of the entries individually.
Since we're now providing visible anchor links, it's important that ID attributes on headings are genuinely unique.
johnbartholomew
force-pushed
the
doc-anchors
branch
from
3d2cb09 to
79820ad
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uses AnchorJS: https://www.bryanbraun.com/anchorjs/
It could be done without JS, which might be nicer, but the docs already use JS (and WASM) to serve the codemirror, interactive elements, and also the MathJax formatting for the detailed language specification. For now, using AnchorJS provides an easy fix. Note that the actual heading elements mostly (all? I haven't checked every individual one) already had
idattributes which can be referenced in the URL fragment; they just didn't have a visible link for someone to copy.Fixes #1104.