fix(theme): add bash style to Markdown comment styles #7049
+5
−3
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]Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site settings. |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-7049--docusaurus-2.netlify.app/ |
|
Could you simply add |
|
ah not as simple as expected, different behavior between docusaurus and a sandbox starter with regards to line highlighting and syntax highlighting with markdown and markdown frontmatter. will open issue / look more into it later when available. |
|
o sorry only just saw this but as said above, not very available right now - you could just do it. |
Josh-Cena
added
pr: maintenance
Josh-Cena
changed the title
Josh-Cena
approved these changes
Mar 29, 2022
Josh-Cena
added
the
pr: internal
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
Currently the code block in https://docusaurus.io/docs/sidebar/autogenerated#autogenerated-sidebar-metadata uses the wrong comment delimiter (
#) for code highlighting - while it is highlighting YAML frontmatter, the code block language ismd, which is used to determine the valid comment delimiters for highlighting (https://github.com/facebook/docusaurus/blob/main/packages/docusaurus-theme-common/src/utils/codeBlockUtils.ts). This changes those comments to use//instead.Have you read the Contributing Guidelines on pull requests?
yes
Test Plan
edit and check the website