Use AnchorJS to automatically generate heading anchors#700
Draft
nchammas wants to merge 3 commits into
Draft
Conversation
Contributor
Author
|
Because this touches |
Contributor
Author
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Right now if you look at a page on the main website like Useful Developer Tools, you'll notice that you cannot easily click on a heading and get an HTML anchor that will let you link directly to that section. On the other hand, if you look at the programming docs, you'll see that you can get anchor links by mousing over a heading.
This discrepancy is because the programming docs include AnchorJS, whereas the main website does not.
This PR adds AnchorJS to the main docs so readers can easily link to headings there like they can on the programming docs:
This adds the latest release of AnchorJS, which is 5.0.0. The programming docs are on AnchorJS 1.1.1, which is more than 11 years old. In a matching PR, I will update the programming docs to also use AnchorJS 5.0.0 so they are consistent.
I built the docs locally and confirmed that the anchors work as expected.