Skip to content

docs: use shiki for syntax highlighting - #65

Merged
VisualBean merged 3 commits into
vnextfrom
docs/reference-updates
Oct 25, 2026
Merged

VisualBean merged 3 commits into
vnextfrom
docs/reference-updates

Conversation

@VisualBean

Copy link
Copy Markdown
Contributor

No description provided.

- references: local references are JSON pointers in a URI, so "/" and "~"
  in a key are escaped as "~1" and "~0", and the pointer is percent-decoded;
  add how references are written, including inlining references whose
  target the written document does not have.
- version conversion: list which references stay references and which are
  written inline, how V2 channel references map to V3 channel keys, and the
  operations and messages a downgrade drops.
- README: drop the JsonPointer.Net attribution, which is no longer a
  dependency, and fix the ReferenceResolutionSetting name and a server
  reference example.
Prism's C# grammar has no raw string literals, so the AsyncAPI documents
embedded in examples were highlighted as C# code, and as a regex-based
grammar it leaves identifiers and properties plain. Its themes also gave
types the same color as numbers and booleans.

Code blocks now use Shiki with Visual Studio Code's grammars and its
Light+ and Dark+ themes, through a swizzled CodeBlock/Content that keeps
the theme's line rendering, so line numbers, highlighted lines and the copy
button still work. Highlighting is synchronous, so pages render the same on
the server and in the browser. C#, JSON, YAML and shell are loaded; other
languages render as plain text.
@VisualBean VisualBean changed the title Use shiki for syntax highlighting docs: use shiki for syntax highlighting Oct 25, 2026
@coderabbitai

coderabbitai Bot commented Oct 25, 2026 •

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 15 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 12689fc9-0525-4c53-9c2d-8815686e96c2
Commits

Reviewing files that changed from the base of the PR and between c686e65 and c1a3d81.

Files ignored due to path filters: 1
  • website/package-lock.json is excluded by !**/package-lock.json
Files selected for processing: 6
  • website/docusaurus.config.js
  • website/package.json
  • website/src/css/custom.css
  • website/src/theme/CodeBlock/Content/index.js
  • website/src/theme/CodeBlock/Content/shiki.js
  • website/src/theme/CodeBlock/Content/styles.module.css
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@VisualBean
VisualBean merged commit 78b8b45 into vnext Oct 25, 2026
5 checks passed
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