Render markdown code fences as rich code blocks#2
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Pre/CodeBlockcomponent<pre>blocks<SUME_API_KEY>placeholdersRailway docs reference
Re-inspected
railwayapp/docsand found the polished API example style is driven by theirCodeBlock/Prepipeline plus code-fence metadata support: a framed code panel, header icon, copy button, selectable text, and syntax highlighting. The new Sume docs repo already had a matchingCodeBlockcomponent, butMarkdownPagedid not map fenced markdownpreelements toPre, so regular.mdfences could not use it.Validation
pnpm install --frozen-lockfilepnpm exec prettier --check src/components/markdown-page.tsx content/docs/public-api.md content/docs/api/reference.md content/docs/api/cookbook.md content/docs-ko/public-api.md content/docs-ko/api/reference.md content/docs-ko/api/cookbook.mdpnpm tscpnpm buildgit diff --check/public-api,/api/reference,/api/cookbook,/ko/public-api,/ko/api/reference,/ko/api/cookbookall returned 200 onhttp://localhost:3001/api/cookbookincludesgroup/code-blockandClick to copy codemarkup for rich code examplesNotes
@propertywarnings remain non-fatal.