chore: use rehype plugin for heading id generation #7701
Merged
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
hbuchel
commented
Jun 3, 2024
There was a problem hiding this comment.
We're not using this anywhere else.
hbuchel
commented
Jun 3, 2024
| @@ -50,33 +53,4 @@ describe('MDXHeading', () => { | |||
| expect(heading).toHaveTextContent(props.children); | |||
| expect(link).not.toBeInTheDocument(); | |||
| }); | |||
|
|
|||
There was a problem hiding this comment.
We're not handling the ID generation anymore so I removed these tests.
hbuchel
commented
Jun 3, 2024
There was a problem hiding this comment.
This page was using a work around to generate H3's with a unique ID using another component. But now we can use normal markdown headings. Also changes some headings to h4. Preview
timngyn
approved these changes
Jun 3, 2024
katieklein
approved these changes
Jun 3, 2024
josefaidt
approved these changes
Jun 4, 2024
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.
Description of changes:
This PR adds a rehype-slug plugin that generates a unique ID for headings. Duplicate headings will have an incremented number attached to them; i.e.
#optionsand#options-1. This fixes an issue where some H3 table of content links with the same name would link to the same heading because we were generating the same id for that heading.Pages to test:
<code>element as childrenRelated GitHub issue #, if available:
Fixes: #6748
Instructions
If this PR should not be merged upon approval for any reason, please submit as a DRAFT
Which product(s) are affected by this PR (if applicable)?
Which platform(s) are affected by this PR (if applicable)?
Please add the product(s)/platform(s) affected to the PR title
Checks
Does this PR conform to the styleguide?
Does this PR include filetypes other than markdown or images? Please add or update unit tests accordingly.
Are any files being deleted with this PR? If so, have the needed redirects been created?
Are all links in MDX files using the MDX link syntax rather than HTML link syntax?
ref: MDX:
[link](https://docs.amplify.aws/)HTML:
<a href="https://docs.amplify.aws/">link</a>When this PR is ready to merge, please check the box below
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.