Skip to content

chore: upgrade comark-content to v0.6.0 - #2635

Merged
atinux merged 3 commits into
mainfrom
chore/comark-content-0.6
Nov 11, 2026
Merged

atinux merged 3 commits into
mainfrom
chore/comark-content-0.6

Conversation

@atinux

@atinux atinux commented Nov 11, 2026 •

Copy link
Copy Markdown
Member

Written by an AI agent on behalf of @atinux.

comark-content 0.6.0 (comarkdown/comark-content#151) stops transliterating and slugifying path segments: $ stays $ instead of becoming dollar. On nuxt.com that moves the $fetch page in every docs version, and the 2.x $nuxt page. Without redirects, the old URLs (linked from search engines, blog posts, and the nuxt/nuxt docs themselves) would 404.

What changed

  • Upgrade: comark-content ^0.5.1 → ^0.6.0. The lockfile is updated, and pnpm added 0.6.0 to minimumReleaseAgeExclude, next to 0.5.1.
  • Redirects (301), in the comark-migration block of routeRules:
    • /docs/2.x/api/internals/dollarnuxt → /docs/2.x/api/internals/$nuxt
    • /docs/{3,4,5}.x/api/utils/dollarfetch → /docs/{3,4,5}.x/api/utils/$fetch
    • /raw/docs/{3,4}.x/api/utils/dollarfetch.md → …/$fetch.md. The old llms.txt listed these raw URLs. 2.x and 5.x have no rule because the site doesn't serve raw Markdown for those versions; every /raw/docs/2.x/… and /raw/docs/5.x/… URL already returns 404.
  • Content cache: CONTENT_PARSER_VERSION goes from v10 to v11. The Vercel Runtime Cache key is the parser version, the instance and the commit sha, so without the bump a deploy reuses manifests that 0.5.1 built at the same commit. The first preview of this PR showed it: /docs/3.x/api/utils/$fetch returned 404 and the 3.x navigation still listed dollarfetch, while the new 301 already sent dollarfetch to $fetch.
  • Links: the /docs/*/api/utils index redirects, content/blog/14.nuxt-on-the-edge.md, the l10n use-fetch.md fixture, and the $nuxt link test in test/unit/docs.spec.ts now use the new paths.

Evidence

Which paths changed. I listed every content file's generated path in all 15 instances (site, examples, docs 2.x–5.x, cli 3.x–5.x, six module docs) on 0.5.1 and on 0.6.0. The sources were local clones of each instance's branch, and the two lists were compared file by file. These are the only differences:

docs:2.x docs/4.api/2.internals/2.$nuxt.md /docs/2.x/api/internals/dollarnuxt -> /docs/2.x/api/internals/$nuxt
docs:3.x docs/4.api/3.utils/$fetch.md      /docs/3.x/api/utils/dollarfetch    -> /docs/3.x/api/utils/$fetch
docs:4.x docs/4.api/3.utils/$fetch.md      /docs/4.x/api/utils/dollarfetch    -> /docs/4.x/api/utils/$fetch
docs:5.x docs/4.api/3.utils/$fetch.md      /docs/5.x/api/utils/dollarfetch    -> /docs/5.x/api/utils/$fetch

Before (nuxt.com production today):

/docs/4.x/api/utils/dollarfetch            200
/docs/4.x/api/utils/$fetch                 404
/docs/4.x/api/utils/%24fetch               404
/docs/3.x/api/utils/dollarfetch            200
/docs/3.x/api/utils/$fetch                 404
/raw/docs/4.x/api/utils/dollarfetch.md     200
/raw/docs/4.x/api/utils/$fetch.md          404

After (pnpm build on this branch, served with node .output/server/index.mjs):

/docs/2.x/api/internals/dollarnuxt     301 -> /docs/2.x/api/internals/$nuxt
/docs/3.x/api/utils/dollarfetch        301 -> /docs/3.x/api/utils/$fetch
/docs/4.x/api/utils/dollarfetch        301 -> /docs/4.x/api/utils/$fetch
/docs/5.x/api/utils/dollarfetch        301 -> /docs/5.x/api/utils/$fetch
/docs/4.x/api/utils/dollarfetch?x=1    301 -> /docs/4.x/api/utils/$fetch?x=1
/docs/api/utils/dollarfetch            302 -> /docs/4.x/api/utils/dollarfetch  (then the 301 above)
/fr/docs/4.x/api/utils/dollarfetch     302 -> /fr/docs/4.x/api/utils/$fetch
/raw/docs/3.x/api/utils/dollarfetch.md 301 -> /raw/docs/3.x/api/utils/$fetch.md
/raw/docs/4.x/api/utils/dollarfetch.md 301 -> /raw/docs/4.x/api/utils/$fetch.md

/docs/2.x/api/internals/$nuxt   200  <title>$nuxt: The Nuxt helper · Nuxt Internals v2</title>
/docs/3.x/api/utils/$fetch      200  <title>$fetch · Nuxt Utils v3</title>
/docs/4.x/api/utils/$fetch      200  <title>$fetch · Nuxt Utils v4</title>
/docs/5.x/api/utils/$fetch      200  <title>$fetch · Nuxt Utils v5</title>
/docs/4.x/api/utils/%24fetch    200  <title>$fetch · Nuxt Utils v4</title>   (canonical: https://nuxt.com/docs/4.x/api/utils/$fetch)
/fr/docs/4.x/api/utils/$fetch   200  <title>$fetch · Utilitaires Nuxt v4</title>
/raw/docs/{3,4}.x/api/utils/$fetch.md  200  # $fetch

Client side, in a browser on that build:

  • Clicking the $fetch sidebar link loads the page, and the link is marked active.
  • Clicking an old dollarfetch link in a page body redirects in the browser to /docs/4.x/api/utils/$fetch.
  • Searching $fetch lists Docs > API > Utils > $fetch (href="/docs/4.x/api/utils/$fetch"), and clicking it opens the page.

Generated indexes:

  • /api/navigation/{2,3,4}.x, sitemap.xml, sitemap.md and llms.txt list only the new paths.
  • llms-full.txt still has old dollarfetch URLs. They come from links inside the nuxt/nuxt docs (see below).

Checks:

  • pnpm vitest run: 77 files, 797 tests passed, including redirect.spec.ts and docs.spec.ts.
  • pnpm lint and pnpm test:types are clean.
  • BASE_URL=<local build> pnpm test:browser: 12 passed, 3 skipped (the same skips as on main).
  • pnpm build: succeeds, and every instance snapshot is written.

On the Vercel preview of dab7108 (the branch alias, behind Vercel Authentication):

/docs/2.x/api/internals/dollarnuxt         301 -> /docs/2.x/api/internals/$nuxt
/docs/3.x/api/utils/dollarfetch            301 -> /docs/3.x/api/utils/$fetch
/docs/4.x/api/utils/dollarfetch            301 -> /docs/4.x/api/utils/$fetch
/docs/5.x/api/utils/dollarfetch            301 -> /docs/5.x/api/utils/$fetch
/raw/docs/3.x/api/utils/dollarfetch.md     301 -> /raw/docs/3.x/api/utils/$fetch.md
/raw/docs/4.x/api/utils/dollarfetch.md     301 -> /raw/docs/4.x/api/utils/$fetch.md

/docs/2.x/api/internals/$nuxt          200 $nuxt: The Nuxt helper · Nuxt Internals v2
/docs/3.x/api/utils/$fetch             200 $fetch · Nuxt Utils v3
/docs/4.x/api/utils/$fetch             200 $fetch · Nuxt Utils v4
/docs/5.x/api/utils/$fetch             200 $fetch · Nuxt Utils v5
/docs/4.x/api/utils/%24fetch           200 $fetch · Nuxt Utils v4
/fr/docs/4.x/api/utils/$fetch          200 $fetch · Utilitaires Nuxt v4
/raw/docs/3.x/api/utils/$fetch.md      200 # $fetch
/raw/docs/4.x/api/utils/$fetch.md      200 # $fetch

/api/navigation/{2,3,4,5}.x            only the new $nuxt / $fetch paths

Details

  • Prerendering: docs pages aren't prerendered (they are ISR). The build prerenders only /nuxt-brand-assets.zip, so there is no prerendered $fetch page to check.
  • Unversioned links: /docs/api/utils/dollarfetch now takes two hops, the existing 302 to the current version and then the new 301. I didn't add a direct rule because the other moved pages don't have one either.
  • Follow-up in nuxt/nuxt: about ten pages per docs version link to /docs/api/utils/dollarfetch (use-fetch.md, data-fetching.md, server-engine.md, …). They keep working through the redirect, but should be changed to $fetch upstream.

ELI5

The library that turns doc file names into web addresses stopped renaming $ to "dollar". So the $fetch page now lives at /api/utils/$fetch instead of /api/utils/dollarfetch. Every old address now permanently forwards to the new one, so existing links and bookmarks keep working.

fetch-page

search-fetch

0.6.0 keeps `$` in content paths instead of spelling it out, so
`$fetch.md` moves from `/api/utils/dollarfetch` to `/api/utils/$fetch`
(and 2.x `$nuxt.md` from `dollarnuxt` to `$nuxt`). Redirect the old
docs and raw Markdown URLs with a 301 and point internal links at the new paths.

Amp-Thread-ID: https://ampcode.com/threads/T-01a1cab2-3a25-7105-aff2-5e2968caf515
@vercel

vercel Bot commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Deployment Actions Updated
nuxt Ready Ready Preview Nov 11, 2026 3:46pm UTC

Request Review

@socket-security

socket-security Bot commented Nov 11, 2026 •

Copy link
Copy Markdown

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Updatedcomark-content@​0.5.1 ⏵ 0.6.095 +6100100 +194 +1100

View full report

@github-actions

github-actions Bot commented Nov 11, 2026 •

Copy link
Copy Markdown

nuxt.com preview

This pull request is closed: its preview is no longer available.

@coderabbitai

coderabbitai Bot commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

Documentation links and redirects now use $fetch and $nuxt URL forms. The documentation-link test checks the $nuxt route. The comark-content dependency range and release-age exclusions are also updated.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: Minimal · up to dab71

This change moves a few documentation URLs to $-based paths, adds permanent redirects from the old paths, and bumps the content cache version. No actionable merge risk was found.

Pre-merge checks: Passed 5

Check name Status Explanation
Title check Passed The title clearly identifies the main change: upgrading comark-content to v0.6.0.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Description check Passed The description directly explains the comark-content upgrade, documentation path changes, redirects, cache version update, link updates, and validation results. It matches the changeset.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 3 files.

Finishing Touches

Generate docstrings

  • Commit to this branch
  • Create a new PR
Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 61602a22-3718-47b1-b047-63ca7afdf7a5
Commits

Reviewing files that changed from the base of the PR and between 57140b0 and dab7108.

Files selected for processing: 1

  • server/utils/content/cache.ts

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 0 remain after this review.

@atinux atinux added the preview:enabled Allows to preview a PR on nuxt.com label Nov 11, 2026
Cached manifests from v0.5 still hold `dollarfetch` paths at the same
commit, so a deploy would serve them until the cache expires.

Amp-Thread-ID: https://ampcode.com/threads/T-01a1cab2-3a25-7105-aff2-5e2968caf515
@github-actions github-actions Bot removed the preview:enabled Allows to preview a PR on nuxt.com label Nov 11, 2026
@atinux atinux added the preview:enabled Allows to preview a PR on nuxt.com label Nov 11, 2026
@github-actions github-actions Bot removed the preview:enabled Allows to preview a PR on nuxt.com label Nov 11, 2026
@nuxt-com-bundle-report

Copy link
Copy Markdown

Bundle size

Explore the comparison →

Client 1.31 MB $\color{red}\textsf{(+92 B, +0.0}\%\textsf{)}$ · Server 8.07 MB $\color{green}\textsf{(-487 B, -0.0}\%\textsf{)}$

Initial page load PR Δ
/docs/2.x/api/internals/dollarnuxt 335.2 kB added
/docs/3.x/api/utils/dollarfetch 335.2 kB added
/docs/4.x/api/utils/dollarfetch 335.2 kB added
/docs/5.x/api/utils/dollarfetch 335.2 kB added
/raw/docs/3.x/api/utils/dollarfetch.md 335.2 kB added
/raw/docs/4.x/api/utils/dollarfetch.md 335.2 kB added
/dashboard/chat/:id() 610.0 kB +109 B (+0.0%)
Largest changes in the server
Package or file Base PR Δ
[unassigned] 6.81 MB 6.81 MB −663 B (−0.0%)
.nuxt/dist/server/_nuxt/slug-styles-2.DHmaf5JZ.mjs n/a 85 B +85 B
.nuxt/dist/server/_nuxt/slug-styles.CC_ke4dZ.mjs n/a 84 B +84 B
.nuxt/dist/server/_nuxt/slug-styles-2.CC_ke4dZ.mjs 82 B n/a −82 B (−100.0%)
.nuxt/dist/server/_nuxt/index-styles.DbAAZlrt.mjs 80 B n/a −80 B (−100.0%)
.nuxt/dist/server/_nuxt/slug-styles.CVjTbRKd.mjs 78 B n/a −78 B (−100.0%)
.nuxt/dist/server/_nuxt/index-styles.CFvzT8RG.mjs n/a 76 B +76 B

Brotli sizes. Changes under 100 B are left out of the tables. Initial page load counts the JavaScript and CSS a route loads before it renders. Measured by nuxt-bundle-analyzer for b371f8e.

@atinux
atinux merged commit c76b7d5 into main Nov 11, 2026
17 checks passed
@atinux
atinux deleted the chore/comark-content-0.6 branch November 11, 2026 16:46

This branch was successfully deployed

1 active deployment
Preview — b371f8e4 Deployed Nov 11, 2026 by vercel[bot]
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