docs: recommend highlighting with comments than number range #6204
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
Josh-Cena
added
the
pr: documentation
Josh-Cena
commented
Dec 28, 2021
Comment on lines
+51
to
+57
| if (!fencedBlock) { | ||
| fencedBlock = true; | ||
| [lastCodeFence] = line.trim().match(/^`+/)!; | ||
| // If we are in a ````-fenced block, all ``` would be plain text instead of fences | ||
| } else if (line.trim().match(/^`+/)![0].length >= lastCodeFence.length) { | ||
| fencedBlock = false; | ||
| } |
There was a problem hiding this comment.
A quick fix because now we have a ```` fenced block with an odd number of ``` fences inside it. Another reason why we want to ultimately do it through a remark parser!
|
✔️ [V2] 🔨 Explore the source changes: c248b82 🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/61ca79c13518ee0008c4a8c3 😎 Browse the preview: https://deploy-preview-6204--docusaurus-2.netlify.app |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-6204--docusaurus-2.netlify.app/ |
|
Size Change: 0 B Total Size: 662 kB ℹ️ View Unchanged
|
|
agree 👍 thanks |
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
There are also some hidden motivations:
MDXComponentProvideris not wired (Feed generation warns: "Receivedtruefor a non-boolean attribute" when using {2,3} highlighting #6195). Well, highlighting comments don't work either, but they don't emit warnings.I didn't change our own usage for dogfooding purposes. In the future, if we are to update those code blocks, we'll also convert them to highlighting with comments.
Have you read the Contributing Guidelines on pull requests?
Yes