Document syntax highlighting for MDX code blocks #444
Conversation
MDX syntax highlighting can’t possibly support all past, present, and future languages in code blocks. Extensions can inject their own syntax highlighting. This documentation helps extension authors to support their own language in MDX code blocks.
remcohaszing
added
📚 area/docs
🦋 Changeset detectedLatest commit: 37615ee The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
This comment has been minimized.
This comment has been minimized.
packages/vscode-mdx/README.md
Outdated
| "name": "markup.code.LANGUAGE.mdx", | ||
| "patterns": [ | ||
| { | ||
| "include": "source.LANGUAGE" |
There was a problem hiding this comment.
not all languages are source.*, perhaps use another variable name, SCOPE or so?
There was a problem hiding this comment.
For Astro it’s even more complex. Perhaps I should write something like:
"patterns": [
// Your patterns, typically something like:
// {
// "include": "source.LANGUAGE"
// }
]There was a problem hiding this comment.
Or, just use a practical example. Such as the mermaid one. And then tell people: change it to the needs of your language.
There was a problem hiding this comment.
Do you mean to replace LANGUAGE with mermaid throughout the entire example?
There was a problem hiding this comment.
yeah something along those lines: say something along the lines of “here’s how Mermaid injects itself into MDX, which you can use as inspiration when doing similar things” and then the code blocks, with actual working code for mermaid
There was a problem hiding this comment.
Done. IMO it’s neither better nor worse.
The actual Mermaid example implementation slightly different, because they use a build script to include the entire YAML language within the injection. But this exact example would have worked too, it’s what I generally recommend.
It’s unnecessary complexity for such a simple case.
This example is more real.
This comment has been minimized.
This comment has been minimized.
Initial checklist
Description of changes
MDX syntax highlighting can’t possibly support all past, present, and future languages in code blocks. Extensions can inject their own syntax highlighting.
This documentation helps extension authors to support their own language in MDX code blocks.