Add id attributes to heading elements #55
Merged
Conversation
This file contains 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
This changes the generated HTML to include `id` attributes on any heading (e.g. `h3`) elements. Currently, `bit-docs-html-toc` will add `id` attributes when it parses the content and creates the TOC links. This means that JS has to be downloaded, parsed, and run before `bit-docs-html-toc` runs its code, and _then_ there has to be more JS to scroll down to the right fragment. This takes JS completely out of the equation by including the `id` attributes in the source HTML, so JS doesn’t need to load and `bit-docs-html-toc` isn’t required to make fragment URLs work either. Part of https://bitovi.atlassian.net/browse/LD-203
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.
This changes the generated HTML to include
idattributes on any heading (e.g.h3) elements.Currently,
bit-docs-html-tocwill addidattributes when it parses the content and creates the TOC links. This means that JS has to be downloaded, parsed, and run beforebit-docs-html-tocruns its code, and then there has to be more JS to scroll down to the right fragment.This takes JS completely out of the equation by including the
idattributes in the source HTML, so JS doesn’t need to load andbit-docs-html-tocisn’t required to make fragment URLs work either.Part of https://bitovi.atlassian.net/browse/LD-203