feat: migrate content layer to comark-content - #2400
Draft
larbish wants to merge 31 commits into
Draft
Conversation
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
# Conflicts: # app/pages/docs/[...slug].vue # package.json # pnpm-lock.yaml # pnpm-workspace.yaml
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
Production bundleComparing
Largest module increases
|
# Conflicts: # app/pages/changelog.vue # app/pages/docs/[...slug].vue # nuxt.config.ts # package.json # pnpm-lock.yaml # pnpm-workspace.yaml # server/mcp/prompts/deploy/deployment-guide.ts # server/mcp/tools/blog/get-blog-post.ts # server/mcp/tools/deploy/get-deploy-provider.ts # server/mcp/tools/docs/get-documentation-page.ts # server/mcp/tools/docs/get-getting-started-guide.ts # server/mcp/tools/docs/list-documentation-pages.ts # server/routes/design.md.get.ts # server/routes/raw/index.md.get.ts # server/routes/sitemap.md.get.ts # server/routes/sitemap.xml.get.ts # server/utils/mcp.ts # shared/utils/docs.ts
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.
Replaces
@nuxt/contentwithcomark-contenthttps://content.comark.dev
Moving content off a build-time SQLite database onto per-commit instances read from GitHub with ISR + push webhook for freshness.
What changes
site,examples,docs:{3,4,5}.x,cli:{3,4,5}.xA push on any repo invalidates only the cache impacted.
Search is client-side WASM FTS5, hydrated from immutable per-commit artifacts.
ISR instead of prerendering:
POST /api/revalidatepurges exactly the URLs a commit changed (300s TTL as backstop)Highlighter moves on rangi (https://github.com/comarkdown/rangi) instead of shiki
Examples canonicalized to /docs/examples/** (was served under three versioned URLs), with redirects.
Dependencies removed:
@nuxt/content,@nuxtjs/mdc,nuxt-content-twoslash,shiki,twoslash,better-sqlite3.Known regression
CLI reference pages (~18) and examples are out of search until the search DB merges multiple instances (waiting for https://github.com/comarkdown/comark-content/pull/120)
Metrics
Build
mainA one-word docs typo currently rebuilds all 2492 routes. Now it purges the one URL that changed.
Time to publish
mainRuntime (TTFB,
/docs/4.x/getting-started/introduction)mainHIT)MISS)Cold-boot breakdown (comark-content tracing): TBD
Cold
MISSis the one regression. comarkdown/comark-content#120'swithSnapshot()removesthe source walk from cold boot by hydrating from the per-commit snapshot artifact.
Before merge
Needs
VERCEL_BYPASS_TOKEN(build + runtime),WEBHOOK_SECRET,NUXT_OG_IMAGE_SECRETand webhooks onnuxt/nuxt.com,nuxt/nuxt,nuxt/examples,nuxt/cli.