-
-
Notifications
You must be signed in to change notification settings - Fork 8.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(mdx-loader): Ignore contentTitle coming after Markdown thematicBreak #9999
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
✅ [V2]
To edit notification comments on pull requests, go to your Netlify site configuration. |
⚡️ Lighthouse report for the deploy preview of this PR
|
Size Change: 0 B Total Size: 994 kB ℹ️ View Unchanged
|
This was referenced May 19, 2024
This was referenced May 25, 2024
This was referenced May 26, 2024
This was referenced May 27, 2024
This was referenced Aug 4, 2024
This was referenced Aug 12, 2024
This was referenced Aug 21, 2024
This was referenced Aug 27, 2024
This was referenced Sep 1, 2024
This was referenced Sep 4, 2024
This was referenced Sep 4, 2024
This was referenced Sep 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
CLA Signed
Signed Facebook CLA
pr: bug fix
This PR fixes a bug in a past release.
to backport
This PR is planned to be backported to a stable version of Docusaurus
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.
Motivation
This fix shouldn't impact any user, apart some Meta OSS sites like React Native that decided to use
h1
headings in the middle of a doc (which doesn't look good, but it is the current state):Without this change, the
frontMatter.title
won't be injected as ah1
heading at the beginning of the doc (also called "synthetic heading" because it's not a Markdown# Title
)I don't really like to introduce such fancy edge case handling just for Meta sites, but the heuristic to ignore h1 after a thematic break still kind of makes sense for other sites, so if we can make it easier to upgrade to V3 Meta sites and it's not annoying for others, let's do it 🤷♂️
Test Plan
unit tests, React Native upgrade: facebook/react-native-website#4072
Test links
https://deploy-preview-9999--docusaurus-2.netlify.app/