Replace {@includeCode} with synced code fences
#328
Merged
+1,776
−96
Conversation
This file contains hidden or 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
@modelcontextprotocol/ext-apps
@modelcontextprotocol/server-basic-react
@modelcontextprotocol/server-basic-vanillajs
@modelcontextprotocol/server-budget-allocator
@modelcontextprotocol/server-cohort-heatmap
@modelcontextprotocol/server-customer-segmentation
@modelcontextprotocol/server-map
@modelcontextprotocol/server-pdf
@modelcontextprotocol/server-scenario-modeler
@modelcontextprotocol/server-shadertoy
@modelcontextprotocol/server-sheet-music
@modelcontextprotocol/server-system-monitor
@modelcontextprotocol/server-threejs
@modelcontextprotocol/server-transcript
@modelcontextprotocol/server-video-resource
@modelcontextprotocol/server-wiki-explorer
commit: |
jonathanhefner
force-pushed
the
synced-code-snippets
branch
from
d3bdcd8 to
4f78675
Compare
Migrate JSDoc and markdown documentation from `{@includecode ./file#region}`
tags to inline code fences with `source="./file#region"` attributes.
Code examples are now visible directly in source files while remaining
type-checked via their `.examples.ts` source files.
Add `scripts/sync-snippets.ts` to extract code from `//#region` blocks
and sync it into labeled fences. Run with `npm run sync:snippets`.
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
jonathanhefner
force-pushed
the
synced-code-snippets
branch
from
4f78675 to
58019a4
Compare
jonathanhefner
merged commit 1d9b23d
into
modelcontextprotocol:main
11 of 13 checks passed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Migrate JSDoc and markdown documentation from
{@includeCode ./file#region}tags to inline code fences with{source="./file#region"}attributes. Code examples are now visible directly in source files while remaining type-checked via their.examples.tssource files.Add
scripts/sync-snippets.tsto extract code from//#regionblocks and sync it into labeled fences. Run withnpm run sync:snippets.@ochafik This is based on what we talked about in #302 (comment). Getting TypeDoc to omit custom (inline) tags would likely require a TypeDoc plugin, so I ended up using code fence attribute syntax instead, which I think works nicely.