feat(mdx-loader): wrap mdx content title (# Title) in <header> for concistency
#10335
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: +581 B (+0.01%) Total Size: 10.9 MB
ℹ️ View Unchanged
|
slorber
reviewed
Jul 25, 2024
Comment on lines
31
to
33
| `, | ||
| {removeContentTitle: true}, | ||
| ); |
There was a problem hiding this comment.
Some test needed removeContentTitle: true throw Cannot handle unknown node 'mdxJsxFlowElement' and test returns content unmodified still fails thrown: "Exceeded timeout of 15000 ms for a test.
Why would that test now need removeContentTitle: true. I tested locally and if it now timeouts, there must be a very good reason that we should find out.
There was a problem hiding this comment.
At first I couldn't really understand, and thought the timeout was coming from the visitor, but it turns out our test setup is not good and does not permit to stringify back to Markdown elements such as mdxJsxFlowElement
Going to fix it
slorber
changed the title
# Title) in <header> for concistency
slorber
added
the
Argos
|
Note for the future:
For now the implementation is probably enough. |
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
slorber
changed the title
# Title) in <header> for concistency# Title) in <header> for concistency
This was referenced Aug 30, 2024
Closed
This was referenced Aug 31, 2024
Open
This was referenced Sep 28, 2024
This was referenced Sep 29, 2024
Closed
This was referenced Oct 4, 2024
This was referenced Oct 19, 2024
Open
Open
This was referenced Oct 20, 2024
Merged
This was referenced Nov 10, 2024
This was referenced Nov 11, 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.
Motivation
Fix #8476
For consistency, we want to wrap it all h1 in a
<header>tag, for both of these cases:title: Titlefront matter (already wrapped in<header># Titlein the MDX doc (previously not wrapped in<header>, now fixed)Test Plan
CI & argos
Test links
https://deploy-preview-10335--docusaurus-2.netlify.app/docs
We now have
<header><h1>and not just<h1>Argos reports small visual changes on
# Titleimmediately followed by## Section, but in practice this is an improvement, consistent with front matter title behavior (less spacing)