Skip to content

Pre-render API reference code highlighting#708

Merged
bryantgillespie merged 3 commits into
mainfrom
bry/please-api-spec-stop-killing-vercel
Jun 2, 2026
Merged

Pre-render API reference code highlighting#708
bryantgillespie merged 3 commits into
mainfrom
bry/please-api-spec-stop-killing-vercel

Conversation

@bryantgillespie
Copy link
Copy Markdown
Member

Changes

  • Pre-renders Shiki-highlighted API request and response examples into the generated API reference payloads.
  • Replaces MDC-generated code sample markdown with dedicated API code sample and response example components, and removes the old markdown helpers.
  • Adds shiki plus the package install metadata needed for this generated output path.

Potential Risks

  • Generated API reference payloads are larger because highlighted HTML is stored at build time.

Review Notes

  • Full build not run locally.

@bryantgillespie bryantgillespie requested a review from a team as a code owner June 2, 2026 14:45
@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 2, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jun 2, 2026 4:23pm

Request Review

LogoDocs bound :class to useColorMode().preference, which resolves
differently on server vs client. No CSS targeted those classes, so
remove it.

HomePersonalized rendered localStorage-backed state (recents,
favorites, instance URL) during setup, diverging from SSR output.
Gate that UI behind a mounted flag so server and first client render
share the stable default branch.
@bryantgillespie bryantgillespie merged commit 00b9a89 into main Jun 2, 2026
5 checks passed
@bryantgillespie bryantgillespie deleted the bry/please-api-spec-stop-killing-vercel branch June 2, 2026 16:37
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