Skip to content

docs: use jsonc syntax highlighting for manifest example - #108

Merged
domdomegg merged 1 commit into
modelcontextprotocol:mainfrom
nicolasff:manifest-md-jsonc-syntax
Sep 24, 2025
Merged

docs: use jsonc syntax highlighting for manifest example#108
domdomegg merged 1 commit into
modelcontextprotocol:mainfrom
nicolasff:manifest-md-jsonc-syntax

Conversation

@nicolasff

Copy link
Copy Markdown
Contributor

The example at the start of MANIFEST.md uses // comments in a ​```json code block, which are highlighted as errors on GitHub. Change this syntax hint to ​```jsonc (JSON with comments) for better rendering.


Reference

GitHub documents the languages it supports syntax highlighting for in languages.yml from the github-liguist repo, linked in their docs.

Comparison

To see the difference in GitHub's UI, compare the current version on main to this PR's branch.

Current main

Screenshot 2025-09-20 at 07 42 06

This PR

Screenshot 2025-09-20 at 07 42 20

The example at the start of MANIFEST.md uses // comments in a ```json
code block, which are highlighted as errors on GitHub. Change this
syntax hint to ```jsonc (JSON with comments) for better rendering.

@domdomegg domdomegg left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@domdomegg
domdomegg merged commit f2284f6 into modelcontextprotocol:main Sep 24, 2025
6 checks passed
bryan-anthropic pushed a commit to bryan-anthropic/mcpb that referenced this pull request Oct 28, 2025
…d-jsonc-syntax

docs: use jsonc syntax highlighting for manifest example
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.

2 participants