Components: Prevent generated readmes duplicating h1 elements when published #66180
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
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
mirka
commented
Oct 16, 2024
| { h1: typeDocs.displayName }, | ||
| '<!-- This file is generated automatically and cannot be edited directly. Make edits via TypeScript types and TSDocs. -->', |
There was a problem hiding this comment.
I also appended a note on how to make edits. Especially because there is an "edit link" at the bottom of the Block Editor Handbook pages that points to the readme file.
ciampo
approved these changes
Oct 16, 2024
cbravobernal
added
the
[Type] Bug
karthick-murugan
pushed a commit
to karthick-murugan/gutenberg
that referenced
this pull request
Nov 13, 2024
…blished (WordPress#66180) Co-authored-by: mirka <[email protected]> Co-authored-by: ciampo <[email protected]> Co-authored-by: tyxla <[email protected]>
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.
What?
Fixes an issue with autogenerated component readmes (#66035) that causes a duplicate
h1element when published to the Block Editor Handbook.Why?
Autogenerated readmes have a duplicated
h1element when published, even though manual readmes also have ah1element at the top of the markdown and don't get duplicated.Duplicated
Non-duplicated
Turns out, the script that de-duplicates the
h1only works when the very first thing in the markdown file is theh1.How?
Move the comment down so the
h1can be the first thing in the markdown.Testing Instructions
We'll see when this is published 🤞