Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(code): change jsonc code blocks language identifier #5633

Closed
wants to merge 1 commit into from

Conversation

ClxUne09
Copy link
Contributor

@ClxUne09 ClxUne09 commented Sep 18, 2024

Prerequisites

  • I have read and understood the contributing guide.
  • The commit message follows the conventional commits guidelines.
  • Tests for the changes have been added (for bug fixes / features).
  • Docs have been added/updated (for bug fixes / features).

Description

Changed language identifiers for JSONC code blocks in documentation from json to jsonc to reflect the file format change and ensure correct syntax highlighting.

@ClxUne09
Copy link
Contributor Author

I think the default Markdown with JSX (MDX) and Markdown (MD) renderers don't support the JSON with comments (jsonc) code identifier, unlike modern renderers (e.g., VS Code). This means they won't apply syntax highlighting for jsonc.

Additionally, I made some incorrect changes to the wrong code blocks, including inline code highlighting (e.g., //highlight-start).

@ClxUne09 ClxUne09 closed this Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant