Skip to content

docs: migrate the site from VitePress to Nuxt with the comark-docs layer - #274

Merged
antfu merged 12 commits into
mainfrom
whole-beds-bet
Aug 21, 2026
Merged

docs: migrate the site from VitePress to Nuxt with the comark-docs layer#274
antfu merged 12 commits into
mainfrom
whole-beds-bet

Conversation

@antfubot

Copy link
Copy Markdown
Collaborator

Migrates the docs site to the same stack as comark's docs: Nuxt 4 extending the comark-docs layer (comark-content + Nuxt UI v4 + Tailwind 4), targeting Vercel.

What changed

  • App: docs/ is now a Nuxt app — nuxt.config.ts extends comark-docs, app/app.config.ts carries branding/nav/footer/OG/llms config. VitePress (.vitepress/, vite.config.ts, mermaid/group-icons plugins) is removed.
  • Content: all 142 pages moved to docs/content/ in the layer's numbered-directory convention (1.guide/2.rpc.md, …) with a .navigation.yml per section, preserving the previous sidebar order and all existing URLs (/guide/rpc, /errors/DF0033, …). Every page's H1 became frontmatter title and its lead paragraph description.
  • Syntax: ::: code-group → MDC ::code-group, orphaned twoslash fence meta dropped (was never wired up), <figure class="screenshot"> blocks → markdown images with captions, relative links rewritten to absolute (the layer's extensionless routes resolve them differently than VitePress's directory URLs). GitHub-style callouts and mermaid fences are supported natively by the layer.
  • Landing page: rebuilt with the layer's ::u-page-hero / ::landing-features / ::landing-cta components, same hero copy and feature set as before.
  • Redirects: a small server middleware 308-redirects the old trailing-slash section URLs (/guide//guide).
  • Deployment: netlify.toml removed; docs/vercel.json added (content-only pushes skip redeploys — the layer revalidates via ISR). The layer serves production content from GitHub at request time, so the Vercel project wants a GITHUB_TOKEN to avoid anonymous rate limits.
  • Workspace wiring: docs catalog now holds comark-docs (github spec); knip override and typecheck-coverage exception updated; stale docs/guide/*.md path references in code comments and AGENTS.md updated to the new layout.

Decisions to be aware of

  • blockExoticSubdeps: false (pnpm 11 default is true): the layer pins comark/comark-content/@comark/nuxt to pkg.pr.new snapshot URLs, which pnpm classifies as exotic subdeps; the setting has no per-package allowlist.
  • Four trustPolicyExclude pins for @vercel/functions@3.9.3, @vercel/oidc@3.8.4, @vercel/cli-config@0.2.3, @vercel/cli-exec@1.0.1 — recent Vercel-official releases without trusted-publisher evidence yet.
  • Site URL is set to https://devframe.dev in nuxt.config.ts — adjust if the canonical domain differs.
  • The layer's README notes it's built for the two Comark sites specifically; dev works fully self-contained from local content/, but production assumes Vercel (ISR, runtime cache).
  • The devframeSidebar()/devframeNav() exports from the old VitePress config (unused in-repo) are gone; the layer derives navigation from the content tree.

Verified: pnpm lint && pnpm knip && pnpm test && pnpm typecheck && pnpm build all pass; nuxt dev renders landing, guide (mermaid), adapters (code-group), plugins (screenshots), and error pages; nuxt build completes.


This PR was created with the help of an agent.

@netlify

netlify Bot commented Aug 21, 2026

Copy link
Copy Markdown

Deploy Preview for devfra failed.

Name Link
🔨 Latest commit 3b2e477
🔍 Latest deploy log https://app.netlify.com/projects/devfra/deploys/6a883f041a154700085e9330

@vercel

vercel Bot commented Aug 21, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
devframe Ready Ready Preview Aug 21, 2026 12:07pm

@vercel

vercel Bot commented Aug 21, 2026

Copy link
Copy Markdown

Deployment failed for project devframe with the following error:

The `vercel.json` schema validation failed with the following message: `framework` should be equal to one of the allowed values "container, blitzjs, nextjs, gatsby, remix, react-router, astro, hexo, eleventy, docusaurus-2, docusaurus, preact, solidstart-1, solidstart, dojo, ember, vue, scully, ionic-angular, angular, polymer, svelte, sveltekit, sveltekit-1, ionic-react, create-react-app, gridsome, umijs, sapper, saber, stencil, nuxtjs, redwoodjs, hugo, jekyll, brunch, middleman, zola, hydrogen, vite, tanstack-start, tanstack-start-lovable, vitepress, vuepress, parcel, fastapi, flask, fasthtml, django, ash, eve, sanity, sanity-v2, storybook, nitro, hono, express, h3, koa, nestjs, elysia, fastify, xmcp, python, ruby, rust, axum, actix-web, bun, node, go, services, mastra, "

Learn More: https://vercel.com/docs/concepts/projects/project-configuration

@antfu
antfu merged commit dde828e into main Aug 21, 2026
11 of 15 checks passed
@antfu
antfu deleted the whole-beds-bet branch August 21, 2026 12:07
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.

2 participants