Generate id from heading #4434
Merged
Generate id from heading #4434
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
|
Demo starting at https://vanilla-framework-4434.demos.haus |
bartaz
reviewed
Apr 21, 2022
| @@ -97,7 +103,7 @@ | |||
| var anchor = document.createElement('a'); | |||
| anchor.classList.add('p-side-navigation__link'); | |||
|
|
|||
| // Add all H3s with IDs to the table of contents list | |||
| // Add all H2s with IDs to the table of contents list | |||
There was a problem hiding this comment.
Good catch, thanks for reading the comments ;)
bartaz
reviewed
Apr 21, 2022
templates/static/js/scripts.js
Outdated
| @@ -87,6 +87,12 @@ | |||
|
|
|||
| // Add table of contents to side navigation on documentation pages | |||
| (function () { | |||
| // Generate id from H2s content when it does not exist | |||
| document.querySelectorAll('main h2:not([id])').forEach(function (heading) { | |||
| var id = heading.textContent.toLowerCase().replaceAll(/\s+/g, '-'); | |||
There was a problem hiding this comment.
This may fail with some special characters in headers.
Maybe worth adding some more rules in here. That's what I found in one markdown implementation:
https://github.com/markedjs/marked/blob/30e90e5175700890e6feb1836c57b9404c854466/src/Slugger.js#L19
bartaz
approved these changes
Apr 21, 2022
bartaz
added
Review: QA +1
Review: Code +1 (with changes)
and removed
Review: QA needed
Review: Code needed
labels
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.
Done
h2s without an id and generate one from the heading.(I think in HTML5 any character is allowed for ids except for whitespace, so I kept it simple. Just lower cased it for consistency)
QA
Screenshots