Add support for explicit id attributes of headings#162
Merged
sebastianbenz merged 1 commit intomainfrom Jan 10, 2022
unknown repository
Merged
Add support for explicit id attributes of headings#162sebastianbenz merged 1 commit intomainfrom unknown repository
sebastianbenz merged 1 commit intomainfrom
unknown repository
Conversation
Contributor
Author
|
@patrickkettner FYI |
This was referenced Jan 8, 2022
sebastianbenz
approved these changes
Jan 10, 2022
Collaborator
sebastianbenz
left a comment
sebastianbenz
left a comment
There was a problem hiding this comment.
Looks good - thanks!
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
3 participants
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.
Heading ids are currently generated based on the heading text. As a result, in translated documents headings are not cross-referenced correctly. In the below example the button will link to an incorrect anchor: https://bentojs.dev/de/components/bento-accordion/#web-component
This PR adds support for explicitly setting the id attribute of headings in the Markdown documents to keep them consistent across translations.
This implementation is the same as the one used in the web.dev project: https://github.com/GoogleChrome/web.dev/blob/main/src/site/_plugins/markdown.js
In future, English documentation would need to include explicit IDs for the headings that are cross-referenced in the doc.