Repository navigation
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This branch was successfully deployed
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
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.
Issue URL: N/A
What is the current behavior?
Six pages show text like
isPlatform {/ #isplatform /}in Google results and link previews. Nothing looks wrong on the page itself, only in the<meta name="description">tag.Docusaurus builds a page's description from its first line of text when the frontmatter has none. On these pages that line is a heading, and Docusaurus doesn't remove the
{/* #id */}heading ID syntax we adopted in #4742. It only strips the older{#id}form.What is the new behavior?
These pages now set
descriptionin their frontmatter:native/faqreact/platformvue/platformvue/performanceupdating/4-0react/testing/unit-testing/best-practicesThe v8 copies get the same descriptions. They don't leak today, since v8 headings aren't pinned yet, but their descriptions are the bare first heading, such as
isPlatform.Does this introduce a breaking change?
Other information
These are the only pages without a
descriptionwhose first line after the title is a pinned heading. Other pages start with a paragraph, so their descriptions are unaffected.The bug is still present in the Docusaurus v4 canary, so any new page that starts with a heading needs a
description.