fix(utils): skip h1 headings with hashes in excerpts - #12306
Open
cyphercodes wants to merge 1 commit into
Open
Conversation
✅ [V2]Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
1 participant
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.
Fixes #12305
Motivation
Docusaurus skips H1 headings when deriving automatic page descriptions, but the H1-stripping regex stopped at an additional
#inside heading text likeC#orF#. That left the rest of the heading as the generated description.Test Plan
pnpm vitest run packages/docusaurus-utils/src/__tests__/markdownUtils.test.tspnpm exec eslint packages/docusaurus-utils/src/markdownUtils.ts packages/docusaurus-utils/src/__tests__/markdownUtils.test.tspnpm exec oxfmt --check packages/docusaurus-utils/src/markdownUtils.ts packages/docusaurus-utils/src/__tests__/markdownUtils.test.tsgit diff --checkEnvironment note: local Node is
v22.22.2; repo packages warn they prefer>=24.14, but the targeted tests/lint/format checks passed.