fix: ignore code block lines when creating excerpt #5495
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] 🔨 Explore the source changes: 2d7df85 🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/61374108dbaa550008adc56e 😎 Browse the preview: https://deploy-preview-5495--docusaurus-2.netlify.app |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-5495--docusaurus-2.netlify.app/ |
|
Size Change: -6 B (0%) Total Size: 826 kB ℹ️ View Unchanged
|
|
make sense thanks 👍 someone else reported me this problem and I recommended to always use explicit descriptions, but having a better default would still be useful |
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
Resolves rather rare use case of improperly creating excerpt if multiline code block is at the beginning of MD document. For example, the React Native docs contains the page with code block at first, which creates excerpt containing "`jsx" only.
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
Tests
Related PRs
(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)