From 4f1ecdc975ddde31440632415c28b550397c7d1e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Chopin?= Date: Mon, 2 Nov 2026 12:00:58 +0000 Subject: [PATCH 1/4] docs: lint docs content with comark-linter Bumps comark-docs to 0640755, which ships a comark-linter preset (lint.mjs): the components the layer renders, and links resolved through comark-content. docs/comark-lint.config.ts adds the site's own app/components/prose/ components and its /play and /stream Vue pages, and pnpm lint runs it, so CI checks the docs on every PR. Amp-Thread-ID: https://ampcode.com/threads/T-01a18c64-cf17-72b6-afc0-24d664666b30 --- AGENTS.md | 6 +- docs/comark-lint.config.ts | 17 ++ docs/package.json | 4 +- package.json | 2 +- pnpm-lock.yaml | 349 +++++++++++++++++++++++++++---------- pnpm-workspace.yaml | 1 + 6 files changed, 288 insertions(+), 91 deletions(-) create mode 100644 docs/comark-lint.config.ts diff --git a/AGENTS.md b/AGENTS.md index a795bc4f..b72ca8d3 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -903,7 +903,7 @@ pnpm stub # Point every package's dist/ at src/ for local dev (runs on p pnpm test # Run all package tests pnpm test:spec # Run the SPEC fixtures only pnpm bench # Run the CodSpeed Vitest benches (benchmarks/*.bench.ts; wall-clock locally) -pnpm lint # oxlint + oxfmt --check +pnpm lint # oxlint + oxfmt --check + comark-lint on docs/content pnpm lint:fix # oxlint --fix + oxfmt (write) pnpm typecheck # tsc --noEmit against the root tsconfig pnpm verify # Run lint + test + typecheck @@ -915,6 +915,10 @@ Linting and formatting use [oxlint](https://oxc.rs/docs/guide/usage/linter) and `.oxfmtrc.json` (no semicolons, single quotes, 120 columns, ES5 trailing commas). There is no ESLint or Prettier config. +The docs content is linted with [comark-linter](https://comark-ui.onmax.me/lint/) (`pnpm --filter comark-docs-site lint`): +unknown components, unclosed blocks, and broken links and anchors. `docs/comark-lint.config.ts` extends the +comark-docs layer's preset with the site's own `app/components/prose/` components and its Vue pages. + Utility scripts: ```bash diff --git a/docs/comark-lint.config.ts b/docs/comark-lint.config.ts new file mode 100644 index 00000000..af48e426 --- /dev/null +++ b/docs/comark-lint.config.ts @@ -0,0 +1,17 @@ +import { readdirSync } from 'node:fs' +import preset from 'comark-docs/lint.mjs' + +// The site's own Markdown components: @comark/nuxt registers app/components/prose/ globally. +const prose = readdirSync('app/components/prose').map((file) => + file.replace(/\.vue$/, '').replace(/[A-Z]/g, (c, i) => (i ? '-' : '') + c.toLowerCase()) +) + +export default { + ...preset, + components: [...preset.components, ...prose], + links: { + ...preset.links, + // Vue pages, not Markdown. + routes: (path: string) => ['/play', '/stream'].includes(path) || preset.links.routes(path), + }, +} diff --git a/docs/package.json b/docs/package.json index b616ee15..5cd76069 100644 --- a/docs/package.json +++ b/docs/package.json @@ -7,6 +7,7 @@ "dev": "nuxt dev", "prebuild": "pnpm --filter '../' run build", "build": "nuxt build", + "lint": "comark-lint \"content/**/*.md\"", "generate:schema": "tsx --env-file=.env scripts/generate-schema.ts" }, "dependencies": { @@ -23,7 +24,7 @@ "ai": "catalog:", "beautiful-mermaid": "catalog:", "comark": "workspace:*", - "comark-docs": "github:comarkdown/comark-docs#217ac74a4b9a1cb21d4803318454cac3a0c54e21", + "comark-docs": "github:comarkdown/comark-docs#06407551a4dece562941aecba5c6baed75af3484", "katex": "catalog:", "nuxt": "catalog:", "splitpanes": "catalog:", @@ -34,6 +35,7 @@ "devDependencies": { "@types/json-schema": "catalog:", "@types/splitpanes": "catalog:", + "comark-linter": "catalog:", "tsx": "catalog:" } } diff --git a/package.json b/package.json index ec5de98a..1c07b068 100644 --- a/package.json +++ b/package.json @@ -41,7 +41,7 @@ "test": "pnpm --filter 'comark' run test && pnpm --filter '@comark/*' run test", "test:spec": "cd packages/comark && pnpm vitest run test/index.test.ts -- -spec", "bench": "vitest bench --run --config benchmarks/vitest.config.ts", - "lint": "oxlint . && oxfmt --check .", + "lint": "oxlint . && oxfmt --check . && pnpm --filter comark-docs-site lint", "lint:fix": "oxlint --fix . && oxfmt .", "typecheck": "tsc --noEmit", "verify": "pnpm run lint && pnpm run test && pnpm run typecheck", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index aabefcc4..6ec7fc8a 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -317,6 +317,9 @@ catalogs: beautiful-mermaid: specifier: ^1.1.3 version: 1.1.3 + comark-linter: + specifier: ^0.7.6 + version: 0.7.6 entities: specifier: ^8.1.0 version: 8.1.0 @@ -587,8 +590,8 @@ importers: specifier: workspace:* version: link:../packages/comark comark-docs: - specifier: github:comarkdown/comark-docs#217ac74a4b9a1cb21d4803318454cac3a0c54e21 - version: https://codeload.github.com/comarkdown/comark-docs/tar.gz/217ac74a4b9a1cb21d4803318454cac3a0c54e21(a8824006c9ec6c0d1ceb0c09deb1e32e) + specifier: github:comarkdown/comark-docs#06407551a4dece562941aecba5c6baed75af3484 + version: https://codeload.github.com/comarkdown/comark-docs/tar.gz/06407551a4dece562941aecba5c6baed75af3484(a8824006c9ec6c0d1ceb0c09deb1e32e) katex: specifier: 'catalog:' version: 0.19.1 @@ -614,6 +617,9 @@ importers: '@types/splitpanes': specifier: 'catalog:' version: 2.2.6 + comark-linter: + specifier: 'catalog:' + version: 0.7.6(comark@packages+comark) tsx: specifier: 'catalog:' version: 4.23.15 @@ -2300,26 +2306,11 @@ packages: '@colordx/core@7.3.0': resolution: {integrity: sha512-LVzTTPhX7wpy7TkGjouA9zbbCBIw92RGm7ZQqSKFE0oYE3sMx2FGXz90eVpgw7k/+wrrY+qJ86nHXifZWMS5jA==} - '@comark/nuxt@0.7.0': - resolution: {integrity: sha512-cbYIw7EVp8ZjTgkS3Q/M1av0T+odX/vTdDd865IPDX/Fmtv1pNLg4TxrHTC3w4z9zFq5Gmyu4U1sbirqmSKIfg==} + '@comark/nuxt@0.8.1': + resolution: {integrity: sha512-Kc3SVGjKYfNN4h4dm9SNnQKnMl+bp/PvrZ11WU7qCl8ohdxyl5gjEbjhLT223TzSmbHvCtmxzlK/hXsUHXGA2Q==} peerDependencies: nuxt: ^4.0.0 - '@comark/vue@0.7.0': - resolution: {integrity: sha512-C63ObcCAiM5DKVDhWPz27pCRsvl0IG9XZJDGjFef1h/V4kS6lEjsoyepLdl4pvAPoSn6U0oGiJTgHLj5GCw2rQ==} - peerDependencies: - beautiful-mermaid: ^1.1.3 - katex: ^0.17.0 - shiki: ^4.3.1 - vue: ^3.5.0 - peerDependenciesMeta: - beautiful-mermaid: - optional: true - katex: - optional: true - shiki: - optional: true - '@comark/vue@0.8.1': resolution: {integrity: sha512-zMxShbPfynnSU5AWH7IeXe2RYm8YIqb5r5XC6eX2Rzv5Ed3/jypbCwp2o1JZAEV0/S3Mczil7Nnb0mzMaOAvHA==} peerDependencies: @@ -3617,9 +3608,35 @@ packages: resolution: {integrity: sha512-0Xi3tgwN77w43Q8GCPIrvWmF1J7Peehkts44E0uKNIml9lB8WoUn8YxyUjxBv47XtVR86NWoWALAT+/IEMHJEA==} engines: {node: '>=18.12.0'} - '@nuxt/kit@4.4.8': - resolution: {integrity: sha512-ZUlZ5iYfyfJFDPluhn6ZxFWcsuxWbLnZBc8w3MAROcQ4lYfZ+qFpALBLSNlpc0zhOa++33EE+5PEbOAdVIY+dw==} - engines: {node: '>=18.12.0'} + '@nuxt/kit@4.6.1': + resolution: {integrity: sha512-ld5+/o4EMqyw6Qy+SdEYkezfprS87+p+xOBhnQgXwyrg1EdtILfLeudQ+hX6UyCnsoF6o0SOw3pjN1P4Tg9O0w==} + engines: {node: ^20.19.0 || >=22.12.0} + peerDependencies: + '@nuxt/schema': ^3.0.0 || ^4.0.0 || ^5.0.0-0 + confbox: '>=0.1.0' + dotenv: '*' + giget: '>=3.1.0' + jiti: ^2.0.0 + mlly: ^1.2.0 + oxc-parser: '>=0.56.0' + rolldown: '>=1.0.0' + peerDependenciesMeta: + '@nuxt/schema': + optional: true + confbox: + optional: true + dotenv: + optional: true + giget: + optional: true + jiti: + optional: true + mlly: + optional: true + oxc-parser: + optional: true + rolldown: + optional: true '@nuxt/kit@4.6.3': resolution: {integrity: sha512-djNup72hMvn7C9xp0/KAYeoY9uzbrPguv91SUBjEeSHh49kP/YI4BvxUVHP8sZd3kms5Ht+IZTJ6XAfm9hofKw==} @@ -6721,32 +6738,172 @@ packages: colortranslator@5.0.0: resolution: {integrity: sha512-Z3UPUKasUVDFCDYAjP2fmlVRf1jFHJv1izAmPjiOa0OCIw1W7iC8PZ2GsoDa8uZv+mKyWopxxStT9q05+27h7w==} - comark-content@0.4.1: - resolution: {integrity: sha512-z0nuo3PM53FwBYbxP4rNrUo1QW7jv8YO44HDYaGm2Wx4pmHsLqKdsA6CiHcSOaURze6m7my0Z0YFaLL77LtDUA==} + comark-content@0.4.3: + resolution: {integrity: sha512-xi/M//OUa5cBaNaV8fzWFdWEqcUbmDCjPbqdf88/3SYd2gIL4zoKMoi5J+fulRnzVG56WPRu5wnafxOV8FPoKQ==} hasBin: true + peerDependencies: + forges: ^0.3.0 + peerDependenciesMeta: + forges: + optional: true - comark-docs@https://codeload.github.com/comarkdown/comark-docs/tar.gz/217ac74a4b9a1cb21d4803318454cac3a0c54e21: - resolution: {gitHosted: true, integrity: sha512-/1ja+jlmoebRUZSh+C12SdgaEnRWolTbvzMLxzeVGHKccG7JxY+4DDeQ3YYy7r4USYVv6tODEeCCYSBytrQi3w==, tarball: https://codeload.github.com/comarkdown/comark-docs/tar.gz/217ac74a4b9a1cb21d4803318454cac3a0c54e21} + comark-docs@https://codeload.github.com/comarkdown/comark-docs/tar.gz/06407551a4dece562941aecba5c6baed75af3484: + resolution: {gitHosted: true, integrity: sha512-uVENcOTkQsiYTKfJd4ATh2sucbNIayUurVSAUC1iig0UP9I0Weh1RgOSS+3e8iAHiXzPYvb1149/iI5i4vVyjg==, tarball: https://codeload.github.com/comarkdown/comark-docs/tar.gz/06407551a4dece562941aecba5c6baed75af3484} version: 0.0.1 engines: {node: ^22.22.3 || ^24.15.0 || >=26.0.0} peerDependencies: - nuxt: ^4.6.0 + nuxt: ^4.6.3 - comark@0.7.0: - resolution: {integrity: sha512-680hLtUOBcvBEJCD+iCU20jk5TrIJlIcE6X4npdC4x7LBhCvmiYJgByozR2fKav6DYw7AYoXsJVae65kXV6Qhw==} + comark-linter@0.7.6: + resolution: {integrity: sha512-GxfjHWmt9SVa303DFhTOadv2ycFNlxsHMDl10+qMTUawgGbWleUxJQ1iAUZk6lMPr/NsFyVdcIlbkeAhfn4hDw==} + engines: {node: '>=22.12.0'} + hasBin: true peerDependencies: - beautiful-mermaid: ^1.1.3 - katex: ^0.17.0 - rangi: ^2.2.0 - shiki: ^4.3.1 + '@eslint/markdown': ^8.0.0 + comark: ^0.8.0 + comark-annotate: ^0.7.6 + comark-badge: ^0.7.6 + comark-cards: ^0.7.6 + comark-carousel: ^0.7.6 + comark-cast: ^0.7.6 + comark-charts: ^0.7.6 + comark-chips: ^0.7.6 + comark-cjk: ^0.7.6 + comark-code: ^0.7.6 + comark-code-notes: ^0.7.6 + comark-colors: ^0.7.6 + comark-comments: ^0.7.6 + comark-critic: ^0.7.6 + comark-deflist: ^0.7.6 + comark-details: ^0.7.6 + comark-diagrams: ^0.7.6 + comark-diff: ^0.7.6 + comark-embed: ^0.7.6 + comark-fields: ^0.7.6 + comark-figure: ^0.7.6 + comark-file-tree: ^0.7.6 + comark-footnotes: ^0.7.6 + comark-github: ^0.7.6 + comark-icon: ^0.7.6 + comark-keys: ^0.7.6 + comark-links: ^0.7.6 + comark-magic-move: ^0.7.6 + comark-mark: ^0.7.6 + comark-mathml: ^0.7.6 + comark-media: ^0.7.6 + comark-metrics: ^0.7.6 + comark-outline: ^0.7.6 + comark-pele: ^1.1.0 + comark-properties: ^0.7.6 + comark-qr: ^0.7.6 + comark-quiz: ^0.7.6 + comark-reading-time: ^0.7.6 + comark-sources: ^0.7.6 + comark-steps: ^0.7.6 + comark-table: ^0.7.6 + comark-tabs: ^0.7.6 + comark-tests: ^0.7.6 + comark-ui: ^0.7.6 + comark-xref: ^0.7.6 + comark-zoom: ^0.7.6 + eslint: ^9.15.0 || ^10.0.0 + vite-doctor: ^0.1.0 peerDependenciesMeta: - beautiful-mermaid: + '@eslint/markdown': optional: true - katex: + comark-annotate: optional: true - rangi: + comark-badge: optional: true - shiki: + comark-cards: + optional: true + comark-carousel: + optional: true + comark-cast: + optional: true + comark-charts: + optional: true + comark-chips: + optional: true + comark-cjk: + optional: true + comark-code: + optional: true + comark-code-notes: + optional: true + comark-colors: + optional: true + comark-comments: + optional: true + comark-critic: + optional: true + comark-deflist: + optional: true + comark-details: + optional: true + comark-diagrams: + optional: true + comark-diff: + optional: true + comark-embed: + optional: true + comark-fields: + optional: true + comark-figure: + optional: true + comark-file-tree: + optional: true + comark-footnotes: + optional: true + comark-github: + optional: true + comark-icon: + optional: true + comark-keys: + optional: true + comark-links: + optional: true + comark-magic-move: + optional: true + comark-mark: + optional: true + comark-mathml: + optional: true + comark-media: + optional: true + comark-metrics: + optional: true + comark-outline: + optional: true + comark-pele: + optional: true + comark-properties: + optional: true + comark-qr: + optional: true + comark-quiz: + optional: true + comark-reading-time: + optional: true + comark-sources: + optional: true + comark-steps: + optional: true + comark-table: + optional: true + comark-tabs: + optional: true + comark-tests: + optional: true + comark-ui: + optional: true + comark-xref: + optional: true + comark-zoom: + optional: true + eslint: + optional: true + vite-doctor: optional: true comark@0.8.1: @@ -7514,6 +7671,10 @@ packages: resolution: {integrity: sha512-gIXjKqtFuWEgzFRJA9WCQeSJLZDjgJUOMCMzxtvFq/37KojM1BFGufqsCy0r4qSQmYLsZYMeyRqzIWOMup03sw==} engines: {node: '>=14'} + forges@0.3.1: + resolution: {integrity: sha512-YGJa9mLMHcsVmNOGFz654fW8cgrobq1ALwYYUSmIEAJP0GbpqGg4slBuWP+W/7MY25C8PyJUafB18/d4sshA5g==} + engines: {node: '>=22.18'} + form-data@4.0.6: resolution: {integrity: sha512-vKatAh4SlVfgbv+YtmhiRjhEMJsYpsG1Y2rMQtR+SVSbytsSD1YGzDIcrAJmdFec88u/+VoGmxnl+80gL1tRCQ==} engines: {node: '>= 6'} @@ -8251,9 +8412,6 @@ packages: mark.js@8.11.1: resolution: {integrity: sha512-1I+1qpDt4idfgLQG+BNWmrqku+7/2bi5nLf4YwF8y8zXvmfiTBY3PV3ZibfrjBueCByROpuBjLLFCajqkgYoLQ==} - markdown-exit@1.1.0-beta.2: - resolution: {integrity: sha512-8CzMGVlFZ4DEfnc8KU+4ycUW2SIOuiXqCHD7z51ecVEi/weyc0f2ylQbCm4KoKuVlTZSuMUMnWT0hTyquZ7anQ==} - markdown-exit@1.3.0: resolution: {integrity: sha512-bsqlcm3Hk1ukcG1Al83pp3JjVobu4w1mpZz47OzLw8bCY8XchkCX+PXC32l2TH4nZ7p5WFg2NwpnLDXkY1X7Yw==} @@ -11620,38 +11778,47 @@ snapshots: '@colordx/core@7.3.0': {} - '@comark/nuxt@0.7.0(d23e3aceb9c056f3b00710182c109da7)': + '@comark/nuxt@0.8.1(6fb611547f2753977a77ac69ab03cd91)': dependencies: - '@comark/vue': 0.7.0(beautiful-mermaid@1.1.3)(katex@0.19.1)(rangi@2.2.0)(shiki@4.5.0)(vue@3.5.44(typescript@6.0.3)) - '@nuxt/kit': 4.4.8(magicast@0.5.5) - comark: 0.7.0(beautiful-mermaid@1.1.3)(katex@0.19.1)(rangi@2.2.0)(shiki@4.5.0) + '@comark/vue': 0.8.1(beautiful-mermaid@1.1.3)(katex@0.19.1)(rangi@2.2.0)(shiki@4.5.0)(vue@3.5.44(typescript@6.0.3)) + '@nuxt/kit': 4.6.1(@nuxt/schema@4.6.3)(confbox@0.3.1)(dotenv@17.4.2)(giget@3.3.1)(jiti@2.7.0)(magic-string@1.4.3)(mlly@1.8.2)(oxc-parser@0.153.0)(rolldown@1.2.15)(unplugin@3.4.0(esbuild@0.28.2)(rolldown@1.2.15)(rollup@4.65.1)(vite@8.3.5(@types/node@26.6.6)(esbuild@0.28.2)(jiti@2.7.0)(sass-embedded@1.104.1)(sass@1.104.1)(terser@5.51.2)(tsx@4.23.15)(yaml@2.9.1))) + comark: 0.8.1(beautiful-mermaid@1.1.3)(katex@0.19.1)(rangi@2.2.0)(shiki@4.5.0) nuxt: 4.6.3(@babel/plugin-syntax-jsx@7.29.7(@babel/core@7.29.7(supports-color@10.2.2)))(@babel/plugin-syntax-typescript@7.29.7(@babel/core@7.29.7(supports-color@10.2.2)))(@oxc-project/types@0.150.0)(@parcel/watcher@2.6.0)(@types/node@26.6.6)(@vercel/functions@3.10.3(ws@8.22.0))(@vue/compiler-sfc@3.5.44)(acorn@8.18.0)(confbox@0.3.1)(db0@0.3.4)(dotenv@17.4.2)(esbuild@0.28.2)(giget@3.3.1)(ioredis@5.11.1(supports-color@10.2.2))(lightningcss@1.33.0)(mlly@1.8.2)(oxc-parser@0.153.0)(oxlint@1.90.0)(rolldown@1.2.15)(rollup-plugin-visualizer@7.1.1(rolldown@1.2.15)(rollup@4.65.1))(rollup@4.65.1)(sass-embedded@1.104.1)(sass@1.104.1)(srvx@1.0.5)(supports-color@10.2.2)(terser@5.51.2)(tsx@4.23.15)(typescript@6.0.3)(vite@8.3.5(@types/node@26.6.6)(esbuild@0.28.2)(jiti@2.7.0)(sass-embedded@1.104.1)(sass@1.104.1)(terser@5.51.2)(tsx@4.23.15)(yaml@2.9.1))(vue-tsc@3.3.14(typescript@6.0.3))(yaml@2.9.1) transitivePeerDependencies: + - '@nuxt/schema' - beautiful-mermaid + - confbox + - dotenv + - giget + - jiti - katex - - magicast + - magic-string + - mlly + - oxc-parser - rangi + - rolldown - shiki + - unplugin - vue - '@comark/vue@0.7.0(beautiful-mermaid@1.1.3)(katex@0.19.1)(rangi@2.2.0)(shiki@4.5.0)(vue@3.5.44(typescript@6.0.3))': + '@comark/vue@0.8.1(beautiful-mermaid@1.1.3)(katex@0.18.7)(rangi@2.2.0)(shiki@4.5.0)(vue@3.5.44(typescript@6.0.3))': dependencies: - comark: 0.7.0(beautiful-mermaid@1.1.3)(katex@0.19.1)(rangi@2.2.0)(shiki@4.5.0) + comark: 0.8.1(beautiful-mermaid@1.1.3)(katex@0.18.7)(rangi@2.2.0)(shiki@4.5.0) vue: 3.5.44(typescript@6.0.3) optionalDependencies: beautiful-mermaid: 1.1.3 - katex: 0.19.1 + katex: 0.18.7 shiki: 4.5.0 transitivePeerDependencies: - rangi - '@comark/vue@0.8.1(beautiful-mermaid@1.1.3)(katex@0.18.7)(rangi@2.2.0)(shiki@4.5.0)(vue@3.5.44(typescript@6.0.3))': + '@comark/vue@0.8.1(beautiful-mermaid@1.1.3)(katex@0.19.1)(rangi@2.2.0)(shiki@4.5.0)(vue@3.5.44(typescript@6.0.3))': dependencies: - comark: 0.8.1(beautiful-mermaid@1.1.3)(katex@0.18.7)(rangi@2.2.0)(shiki@4.5.0) + comark: 0.8.1(beautiful-mermaid@1.1.3)(katex@0.19.1)(rangi@2.2.0)(shiki@4.5.0) vue: 3.5.44(typescript@6.0.3) optionalDependencies: beautiful-mermaid: 1.1.3 - katex: 0.18.7 + katex: 0.19.1 shiki: 4.5.0 transitivePeerDependencies: - rangi @@ -12831,30 +12998,38 @@ snapshots: transitivePeerDependencies: - magicast - '@nuxt/kit@4.4.8(magicast@0.5.5)': + '@nuxt/kit@4.6.1(@nuxt/schema@4.6.3)(confbox@0.3.1)(dotenv@17.4.2)(giget@3.3.1)(jiti@2.7.0)(magic-string@1.4.3)(mlly@1.8.2)(oxc-parser@0.153.0)(rolldown@1.2.15)(unplugin@3.4.0(esbuild@0.28.2)(rolldown@1.2.15)(rollup@4.65.1)(vite@8.3.5(@types/node@26.6.6)(esbuild@0.28.2)(jiti@2.7.0)(sass-embedded@1.104.1)(sass@1.104.1)(terser@5.51.2)(tsx@4.23.15)(yaml@2.9.1)))': dependencies: - c12: 3.3.4(magicast@0.5.5) consola: 3.4.2 defu: 6.1.7 destr: 2.0.5 - errx: 0.1.2 + errx: 0.2.2 exsolve: 1.1.3 ignore: 7.0.14 - jiti: 2.7.0 klona: 2.0.6 - mlly: 1.8.2 - ohash: 2.0.12 + microdiff: 1.6.0 + nostics: 1.3.0 + package-manager-detector: 1.9.0 pathe: 2.0.3 - pkg-types: 2.4.0 rc9: 3.1.0 scule: 1.3.0 - semver: 7.8.5 + std-env: 4.3.0 + tinyexec: 1.3.1 tinyglobby: 0.2.17 - ufo: 1.6.4 - unctx: 2.5.0 - untyped: 2.0.0 + unctx: 3.0.1(magic-string@1.4.3)(oxc-parser@0.153.0)(rolldown@1.2.15)(unplugin@3.4.0(esbuild@0.28.2)(rolldown@1.2.15)(rollup@4.65.1)(vite@8.3.5(@types/node@26.6.6)(esbuild@0.28.2)(jiti@2.7.0)(sass-embedded@1.104.1)(sass@1.104.1)(terser@5.51.2)(tsx@4.23.15)(yaml@2.9.1))) + verkit: 0.5.0 + optionalDependencies: + '@nuxt/schema': 4.6.3 + confbox: 0.3.1 + dotenv: 17.4.2 + giget: 3.3.1 + jiti: 2.7.0 + mlly: 1.8.2 + oxc-parser: 0.153.0 + rolldown: 1.2.15 transitivePeerDependencies: - - magicast + - magic-string + - unplugin '@nuxt/kit@4.6.3(@nuxt/schema@4.6.3)(confbox@0.3.1)(dotenv@17.4.2)(giget@3.3.1)(jiti@2.7.0)(magic-string@1.4.1)(mlly@1.8.2)(oxc-parser@0.153.0)(rolldown@1.2.15)(unplugin@3.4.0(esbuild@0.28.2)(rolldown@1.2.15)(rollup@4.65.1)(vite@8.3.5(@types/node@26.6.6)(esbuild@0.28.2)(jiti@2.7.0)(sass-embedded@1.104.1)(sass@1.104.1)(terser@5.51.2)(tsx@4.23.15)(yaml@2.9.1)))': dependencies: @@ -16004,10 +16179,10 @@ snapshots: colortranslator@5.0.0: {} - comark-content@0.4.1(@vercel/functions@3.10.3(ws@8.22.0))(beautiful-mermaid@1.1.3)(db0@0.3.4)(ioredis@5.11.1(supports-color@10.2.2))(katex@0.19.1)(rangi@2.2.0)(shiki@4.5.0): + comark-content@0.4.3(@vercel/functions@3.10.3(ws@8.22.0))(beautiful-mermaid@1.1.3)(db0@0.3.4)(forges@0.3.1)(ioredis@5.11.1(supports-color@10.2.2))(katex@0.19.1)(rangi@2.2.0)(shiki@4.5.0): dependencies: citty: 0.2.2 - comark: 0.7.0(beautiful-mermaid@1.1.3)(katex@0.19.1)(rangi@2.2.0)(shiki@4.5.0) + comark: 0.8.1(beautiful-mermaid@1.1.3)(katex@0.19.1)(rangi@2.2.0)(shiki@4.5.0) hookable: 6.1.2 jiti: 2.7.0 ofetch: 1.5.1 @@ -16016,6 +16191,8 @@ snapshots: slugify: 1.6.9 ufo: 1.6.4 unstorage: 1.17.6(@vercel/functions@3.10.3(ws@8.22.0))(db0@0.3.4)(ioredis@5.11.1(supports-color@10.2.2)) + optionalDependencies: + forges: 0.3.1 transitivePeerDependencies: - '@azure/app-configuration' - '@azure/cosmos' @@ -16041,11 +16218,11 @@ snapshots: - shiki - uploadthing - comark-docs@https://codeload.github.com/comarkdown/comark-docs/tar.gz/217ac74a4b9a1cb21d4803318454cac3a0c54e21(a8824006c9ec6c0d1ceb0c09deb1e32e): + comark-docs@https://codeload.github.com/comarkdown/comark-docs/tar.gz/06407551a4dece562941aecba5c6baed75af3484(a8824006c9ec6c0d1ceb0c09deb1e32e): dependencies: '@ai-sdk/gateway': 4.0.132(zod@4.6.7) '@ai-sdk/vue': 4.0.159(vue@3.5.44(typescript@6.0.3))(zod@4.6.7) - '@comark/nuxt': 0.7.0(d23e3aceb9c056f3b00710182c109da7) + '@comark/nuxt': 0.8.1(6fb611547f2753977a77ac69ab03cd91) '@iconify-json/logos': 1.2.18 '@iconify-json/lucide': 1.2.147 '@iconify-json/simple-icons': 1.2.101 @@ -16069,14 +16246,15 @@ snapshots: '@vueuse/core': 15.0.0(vue@3.5.44(typescript@6.0.3)) ai: 7.0.159(zod@4.6.7) beautiful-mermaid: 1.1.3 - comark: 0.7.0(beautiful-mermaid@1.1.3)(katex@0.19.1)(rangi@2.2.0)(shiki@4.5.0) - comark-content: 0.4.1(@vercel/functions@3.10.3(ws@8.22.0))(beautiful-mermaid@1.1.3)(db0@0.3.4)(ioredis@5.11.1(supports-color@10.2.2))(katex@0.19.1)(rangi@2.2.0)(shiki@4.5.0) + comark: 0.8.1(beautiful-mermaid@1.1.3)(katex@0.19.1)(rangi@2.2.0)(shiki@4.5.0) + comark-content: 0.4.3(@vercel/functions@3.10.3(ws@8.22.0))(beautiful-mermaid@1.1.3)(db0@0.3.4)(forges@0.3.1)(ioredis@5.11.1(supports-color@10.2.2))(katex@0.19.1)(rangi@2.2.0)(shiki@4.5.0) defu: 6.1.7 exsolve: 1.1.3 + forges: 0.3.1 js-yaml: 5.5.0 motion-v: 2.8.0(@vueuse/core@15.0.0(vue@3.5.44(typescript@6.0.3)))(react-dom@19.3.1(react@19.3.1))(react@19.3.1)(vue@3.5.44(typescript@6.0.3)) nuxt: 4.6.3(@babel/plugin-syntax-jsx@7.29.7(@babel/core@7.29.7(supports-color@10.2.2)))(@babel/plugin-syntax-typescript@7.29.7(@babel/core@7.29.7(supports-color@10.2.2)))(@oxc-project/types@0.150.0)(@parcel/watcher@2.6.0)(@types/node@26.6.6)(@vercel/functions@3.10.3(ws@8.22.0))(@vue/compiler-sfc@3.5.44)(acorn@8.18.0)(confbox@0.3.1)(db0@0.3.4)(dotenv@17.4.2)(esbuild@0.28.2)(giget@3.3.1)(ioredis@5.11.1(supports-color@10.2.2))(lightningcss@1.33.0)(mlly@1.8.2)(oxc-parser@0.153.0)(oxlint@1.90.0)(rolldown@1.2.15)(rollup-plugin-visualizer@7.1.1(rolldown@1.2.15)(rollup@4.65.1))(rollup@4.65.1)(sass-embedded@1.104.1)(sass@1.104.1)(srvx@1.0.5)(supports-color@10.2.2)(terser@5.51.2)(tsx@4.23.15)(typescript@6.0.3)(vite@8.3.5(@types/node@26.6.6)(esbuild@0.28.2)(jiti@2.7.0)(sass-embedded@1.104.1)(sass@1.104.1)(terser@5.51.2)(tsx@4.23.15)(yaml@2.9.1))(vue-tsc@3.3.14(typescript@6.0.3))(yaml@2.9.1) - nuxt-agent-discovery: 0.7.1(6eb818a6de2c810105f48bbf8fa5fdae) + nuxt-agent-discovery: 0.7.1(fbdf3cc909f73732ef6fcec5b204eacf) nuxt-llms: 0.3.0(@nuxt/schema@4.6.3)(confbox@0.3.1)(dotenv@17.4.2)(giget@3.3.1)(jiti@2.7.0)(magic-string@1.4.3)(mlly@1.8.2)(oxc-parser@0.153.0)(rolldown@1.2.15)(unplugin@3.4.0(esbuild@0.28.2)(rolldown@1.2.15)(rollup@4.65.1)(vite@8.3.5(@types/node@26.6.6)(esbuild@0.28.2)(jiti@2.7.0)(sass-embedded@1.104.1)(sass@1.104.1)(terser@5.51.2)(tsx@4.23.15)(yaml@2.9.1))) nuxt-og-image: 7.0.7(f3c554cc1af7f4426fdda7fe539f346b) nuxt-schema-org: 7.0.1(89f90675130bb42c27e6c72b9b4de240) @@ -16208,26 +16386,29 @@ snapshots: - ws - yup - comark@0.7.0(beautiful-mermaid@1.1.3)(katex@0.19.1)(rangi@2.2.0)(shiki@4.5.0): + comark-linter@0.7.6(comark@packages+comark): + dependencies: + comark: link:packages/comark + + comark@0.8.1(beautiful-mermaid@1.1.3)(katex@0.18.7)(rangi@2.2.0)(shiki@4.5.0): dependencies: entities: 8.1.0 - htmlparser2: 12.0.0 js-yaml: 5.5.0 - markdown-exit: 1.1.0-beta.2 + markdown-exit: 1.3.0 optionalDependencies: beautiful-mermaid: 1.1.3 - katex: 0.19.1 + katex: 0.18.7 rangi: 2.2.0 shiki: 4.5.0 - comark@0.8.1(beautiful-mermaid@1.1.3)(katex@0.18.7)(rangi@2.2.0)(shiki@4.5.0): + comark@0.8.1(beautiful-mermaid@1.1.3)(katex@0.19.1)(rangi@2.2.0)(shiki@4.5.0): dependencies: entities: 8.1.0 js-yaml: 5.5.0 markdown-exit: 1.3.0 optionalDependencies: beautiful-mermaid: 1.1.3 - katex: 0.18.7 + katex: 0.19.1 rangi: 2.2.0 shiki: 4.5.0 @@ -17007,6 +17188,8 @@ snapshots: cross-spawn: 7.0.6 signal-exit: 4.1.0 + forges@0.3.1: {} + form-data@4.0.6: dependencies: asynckit: 0.4.0 @@ -17725,16 +17908,6 @@ snapshots: mark.js@8.11.1: {} - markdown-exit@1.1.0-beta.2: - dependencies: - '@types/linkify-it': 5.0.0 - '@types/mdurl': 2.0.0 - entities: 7.0.1 - linkify-it: 5.0.2 - mdurl: 2.1.0 - punycode.js: 2.3.1 - uc.micro: 2.1.0 - markdown-exit@1.3.0: dependencies: '@types/linkify-it': 5.0.0 @@ -18449,7 +18622,7 @@ snapshots: dependencies: boolbase: 2.0.0 - nuxt-agent-discovery@0.7.1(6eb818a6de2c810105f48bbf8fa5fdae): + nuxt-agent-discovery@0.7.1(fbdf3cc909f73732ef6fcec5b204eacf): dependencies: '@nuxt/kit': 4.6.3(@nuxt/schema@4.6.3)(confbox@0.3.1)(dotenv@17.4.2)(giget@3.3.1)(jiti@2.7.0)(magic-string@1.4.3)(mlly@1.8.2)(oxc-parser@0.153.0)(rolldown@1.2.15)(unplugin@3.4.0(esbuild@0.28.2)(rolldown@1.2.15)(rollup@4.65.1)(vite@8.3.5(@types/node@26.6.6)(esbuild@0.28.2)(jiti@2.7.0)(sass-embedded@1.104.1)(sass@1.104.1)(terser@5.51.2)(tsx@4.23.15)(yaml@2.9.1))) defu: 6.1.7 @@ -18460,7 +18633,7 @@ snapshots: '@nuxtjs/mcp-toolkit': 0.24.2(@nuxt/schema@4.6.3)(@vue/compiler-sfc@3.5.44)(confbox@0.3.1)(dotenv@17.4.2)(giget@3.3.1)(h3@1.15.11)(jiti@2.7.0)(magic-string@1.4.3)(mlly@1.8.2)(oxc-parser@0.153.0)(rolldown@1.2.15)(rollup@4.65.1)(supports-color@10.2.2)(unplugin@3.4.0(esbuild@0.28.2)(rolldown@1.2.15)(rollup@4.65.1)(vite@8.3.5(@types/node@26.6.6)(esbuild@0.28.2)(jiti@2.7.0)(sass-embedded@1.104.1)(sass@1.104.1)(terser@5.51.2)(tsx@4.23.15)(yaml@2.9.1)))(vite@8.3.5(@types/node@26.6.6)(esbuild@0.28.2)(jiti@2.7.0)(sass-embedded@1.104.1)(sass@1.104.1)(terser@5.51.2)(tsx@4.23.15)(yaml@2.9.1))(vue@3.5.44(typescript@6.0.3))(zod@4.6.7) '@nuxtjs/robots': 7.0.2(62410f4b4d164de7daa75ca3f57edf5c) '@nuxtjs/sitemap': 9.1.0(9493a55afff073c23b24cfce8deb396d) - comark: 0.7.0(beautiful-mermaid@1.1.3)(katex@0.19.1)(rangi@2.2.0)(shiki@4.5.0) + comark: 0.8.1(beautiful-mermaid@1.1.3)(katex@0.19.1)(rangi@2.2.0)(shiki@4.5.0) nuxt-llms: 0.3.0(@nuxt/schema@4.6.3)(confbox@0.3.1)(dotenv@17.4.2)(giget@3.3.1)(jiti@2.7.0)(magic-string@1.4.3)(mlly@1.8.2)(oxc-parser@0.153.0)(rolldown@1.2.15)(unplugin@3.4.0(esbuild@0.28.2)(rolldown@1.2.15)(rollup@4.65.1)(vite@8.3.5(@types/node@26.6.6)(esbuild@0.28.2)(jiti@2.7.0)(sass-embedded@1.104.1)(sass@1.104.1)(terser@5.51.2)(tsx@4.23.15)(yaml@2.9.1))) transitivePeerDependencies: - '@nuxt/schema' diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml index 51413bf8..bb2a2c8d 100644 --- a/pnpm-workspace.yaml +++ b/pnpm-workspace.yaml @@ -107,6 +107,7 @@ catalog: nuxt-studio: 1.8.0 # Linting + comark-linter: ^0.7.6 oxfmt: ^0.75.0 oxlint: ^1.90.0 playwright: ^1.64.1 From 3312b7b51c4d5b266c8f8e37c52a987c580be8ed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Chopin?= Date: Mon, 2 Nov 2026 12:00:58 +0000 Subject: [PATCH 2/4] docs: fix anchors for flat heading ids and use tabs-item The bumped layer renders with comark 0.8, whose heading ids are flat, so 112 links to nested or older code- ids are pointed at the flat id of the heading each meant. The 9 tab-item blocks become Nuxt UI's tabs-item, without the gap-0 that made up for the raw element's margin. Amp-Thread-ID: https://ampcode.com/threads/T-01a18c64-cf17-72b6-afc0-24d664666b30 --- .../1.getting-started/1.installation.md | 18 +++++----- docs/content/10.use-cases/3.vue-ai-chat.md | 2 +- docs/content/10.use-cases/4.svelte-ai-chat.md | 4 +-- .../content/10.use-cases/5.angular-ai-chat.md | 2 +- .../10.use-cases/8.cms-runtime-content.md | 2 +- .../11.comark-vs-vue-markdown-render.md | 2 +- .../11.compare/9.comark-vs-markdown-to-jsx.md | 2 +- docs/content/3.rendering/2.html.md | 12 +++---- docs/content/3.rendering/3.vue.md | 34 +++++++++---------- docs/content/3.rendering/4.nuxt.md | 10 +++--- docs/content/3.rendering/5.react.md | 34 +++++++++---------- docs/content/3.rendering/6.svelte.md | 26 +++++++------- docs/content/3.rendering/7.angular.md | 8 ++--- docs/content/3.rendering/8.ansi.md | 16 ++++----- docs/content/4.plugins/1.built-in/headings.md | 6 ++-- .../4.plugins/1.built-in/punctuation.md | 10 +++--- docs/content/4.plugins/1.built-in/security.md | 22 ++++++------ docs/content/4.plugins/1.built-in/shiki.md | 14 ++++---- docs/content/4.plugins/1.built-in/summary.md | 2 +- docs/content/4.plugins/1.built-in/toc.md | 6 ++-- .../4.plugins/2.custom/1.plugin-api.md | 2 +- docs/content/5.reference/0.render.md | 8 ++--- docs/content/7.kb/4.twoslash.md | 6 ++-- 23 files changed, 124 insertions(+), 124 deletions(-) diff --git a/docs/content/1.getting-started/1.installation.md b/docs/content/1.getting-started/1.installation.md index da9c6433..a410a3a2 100644 --- a/docs/content/1.getting-started/1.installation.md +++ b/docs/content/1.getting-started/1.installation.md @@ -125,8 +125,8 @@ Comark packages share one pipeline. The core parser produces a serializable `Mar Use these when you need to render Markdown as an interactive document in Vue, React, Nuxt, Svelte, or Angular. -::tabs{class="gap-0"} - ::tab-item{label="Vue" icon="i-logos-vue"} +::tabs + ::tabs-item{label="Vue" icon="i-logos-vue"} ::code-group ```bash [pnpm] pnpm add @comark/vue @@ -142,7 +142,7 @@ Use these when you need to render Markdown as an interactive document in Vue, Re ``` :: :: - ::tab-item{label="React" icon="i-logos-react"} + ::tabs-item{label="React" icon="i-logos-react"} ::code-group ```bash [pnpm] pnpm add @comark/react @@ -158,12 +158,12 @@ Use these when you need to render Markdown as an interactive document in Vue, Re ``` :: :: - ::tab-item{label="Nuxt" icon="i-logos-nuxt-icon"} + ::tabs-item{label="Nuxt" icon="i-logos-nuxt-icon"} ```bash [Terminal] npx nuxt add comark ``` :: - ::tab-item{label="Svelte" icon="i-logos-svelte-icon"} + ::tabs-item{label="Svelte" icon="i-logos-svelte-icon"} ::code-group ```bash [pnpm] pnpm add @comark/svelte @@ -179,7 +179,7 @@ Use these when you need to render Markdown as an interactive document in Vue, Re ``` :: :: - ::tab-item{label="Angular" icon="i-logos-angular-icon"} + ::tabs-item{label="Angular" icon="i-logos-angular-icon"} ::code-group ```bash [pnpm] pnpm add @comark/angular @@ -201,8 +201,8 @@ Use these when you need to render Markdown as an interactive document in Vue, Re Use these when you need a string output with no UI framework involved like server-side HTML generation, static site builds, or CLI tooling. -::tabs{class="gap-0"} - ::tab-item{label="HTML" icon="i-vscode-icons-file-type-html"} +::tabs + ::tabs-item{label="HTML" icon="i-vscode-icons-file-type-html"} ::code-group ```bash [pnpm] pnpm add @comark/html @@ -218,7 +218,7 @@ Use these when you need a string output with no UI framework involved like serve ``` :: :: - ::tab-item{label="ANSI" icon="i-lucide-terminal"} + ::tabs-item{label="ANSI" icon="i-lucide-terminal"} ::code-group ```bash [pnpm] pnpm add @comark/ansi diff --git a/docs/content/10.use-cases/3.vue-ai-chat.md b/docs/content/10.use-cases/3.vue-ai-chat.md index 05d5021a..71d44726 100644 --- a/docs/content/10.use-cases/3.vue-ai-chat.md +++ b/docs/content/10.use-cases/3.vue-ai-chat.md @@ -143,7 +143,7 @@ const plugins = [ ::: :::accordion-item{label="Can I render the answer on the server?"} - Chat messages arrive in the browser, so client rendering is enough. For server-rendered content, parse on the server and render with [``](/rendering/vue#code-markdowndocument). + Chat messages arrive in the browser, so client rendering is enough. For server-rendered content, parse on the server and render with [``](/rendering/vue#markdowndocument). ::: :::accordion-item{label="Can the model write Comark components?"} diff --git a/docs/content/10.use-cases/4.svelte-ai-chat.md b/docs/content/10.use-cases/4.svelte-ai-chat.md index c109cf32..9faeefb6 100644 --- a/docs/content/10.use-cases/4.svelte-ai-chat.md +++ b/docs/content/10.use-cases/4.svelte-ai-chat.md @@ -143,11 +143,11 @@ Raw HTML in model output is parsed into nodes by default. Add the [security plug ::: :::accordion-item{label="Why is my Markdown missing from the server HTML?"} - `` renders only in the browser. Parse on the server and use ``, or use the experimental [``](/rendering/svelte#code-markdownasync-code-experimental). + `` renders only in the browser. Parse on the server and use ``, or use the experimental [``](/rendering/svelte#markdownasync-experimental). ::: :::accordion-item{label="How do I map a component to a Svelte component?"} - Pass a `components` map, for example `components={{ alert: Alert }}`. See [Svelte components](/rendering/svelte#code-markdown-props-code-components). + Pass a `components` map, for example `components={{ alert: Alert }}`. See [Svelte components](/rendering/svelte#components). ::: :: diff --git a/docs/content/10.use-cases/5.angular-ai-chat.md b/docs/content/10.use-cases/5.angular-ai-chat.md index 845ba3e3..fa21f4c7 100644 --- a/docs/content/10.use-cases/5.angular-ai-chat.md +++ b/docs/content/10.use-cases/5.angular-ai-chat.md @@ -141,7 +141,7 @@ Comark passes component props as `@Input()` values. The default slot maps to `` with a document from `parseMarkdown()`. It renders the document without a parse step. See [``](/rendering/angular#code-comark-markdown-document). + Use `` with a document from `parseMarkdown()`. It renders the document without a parse step. See [``](/rendering/angular#comark-markdown-document). ::: :: diff --git a/docs/content/10.use-cases/8.cms-runtime-content.md b/docs/content/10.use-cases/8.cms-runtime-content.md index 41cb0248..40289775 100644 --- a/docs/content/10.use-cases/8.cms-runtime-content.md +++ b/docs/content/10.use-cases/8.cms-runtime-content.md @@ -111,7 +111,7 @@ const markdown = await renderMarkdown(document) await savePage(row.slug, markdown) ``` -The output can differ from the original formatting. For example, a component with more than three attributes moves them to a YAML block. See the [`maxInlineAttributes`](/reference/render#options-maxinlineattributes) option. +The output can differ from the original formatting. For example, a component with more than three attributes moves them to a YAML block. See the [`maxInlineAttributes`](/reference/render#maxinlineattributes) option. ## FAQ diff --git a/docs/content/11.compare/11.comark-vs-vue-markdown-render.md b/docs/content/11.compare/11.comark-vs-vue-markdown-render.md index 52755204..437b3c0c 100644 --- a/docs/content/11.compare/11.comark-vs-vue-markdown-render.md +++ b/docs/content/11.compare/11.comark-vs-vue-markdown-render.md @@ -143,7 +143,7 @@ If you render trusted, static Markdown and don't need components, vue-markdown-r ::: :::accordion-item{label="Why does Comark's Markdown component need Suspense?"} - `` parses asynchronously. To skip parsing in the browser, parse on the server and render the document with ``. It ships no parser to the client. See [`MarkdownDocument`](/rendering/vue#code-markdowndocument). + `` parses asynchronously. To skip parsing in the browser, parse on the server and render the document with ``. It ships no parser to the client. See [`MarkdownDocument`](/rendering/vue#markdowndocument). ::: :::accordion-item{label="Does Comark work with Nuxt and Nuxt UI?"} diff --git a/docs/content/11.compare/9.comark-vs-markdown-to-jsx.md b/docs/content/11.compare/9.comark-vs-markdown-to-jsx.md index 555bc0a4..5cc09bd7 100644 --- a/docs/content/11.compare/9.comark-vs-markdown-to-jsx.md +++ b/docs/content/11.compare/9.comark-vs-markdown-to-jsx.md @@ -117,7 +117,7 @@ const plugins = [security({ blockedTags: ['script', 'iframe', 'object', 'embed', - **Zero dependencies**: Comark's parser bundle is larger, because it includes markdown-exit, a YAML parser, an HTML parser, and entity tables. - **Output targets**: React Native and Solid are outputs that Comark doesn't have. -- **React Server Components**: the `Markdown` component detects RSC and needs no `'use client'` directive. Comark's [`MarkdownDocument`](/rendering/react#code-markdowndocument) also renders in a Server Component. +- **React Server Components**: the `Markdown` component detects RSC and needs no `'use client'` directive. Comark's [`MarkdownDocument`](/rendering/react#markdowndocument) also renders in a Server Component. - **Secure defaults**: the tag filter and raw HTML sanitization need no setup. If you render trusted Markdown with JSX components in React, React Native, or Solid, markdown-to-jsx is a good fit. Choose Comark when you need components with named slots, streaming that completes syntax, or Svelte, Angular, or terminal output. diff --git a/docs/content/3.rendering/2.html.md b/docs/content/3.rendering/2.html.md index 6b54e97d..ed4f34bc 100644 --- a/docs/content/3.rendering/2.html.md +++ b/docs/content/3.rendering/2.html.md @@ -89,9 +89,9 @@ This is a **bold** statement with a [link](https://example.com). | Option | Type | Default | Description | | --- | --- | --- | --- | -| [`plugins`](#render-options-plugins) | `ComarkPlugin[]` | `[]` | Array of plugins | -| [`components`](#render-options-components) | `Record` | `{}` | Custom component renderers | -| [`data`](#render-options-data) | `Record` | `undefined` | Data passed to component renderers | +| [`plugins`](#plugins) | `ComarkPlugin[]` | `[]` | Array of plugins | +| [`components`](#components) | `Record` | `{}` | Custom component renderers | +| [`data`](#data) | `Record` | `undefined` | Data passed to component renderers | | `autoClose` | `boolean` | `true` | Close incomplete Markdown and components before parsing | | `autoUnwrap` | `boolean` | `true` | Remove a single paragraph wrapper inside components | | `linkify` | `boolean` | `true` | Convert URL-like text into links | @@ -198,7 +198,7 @@ const html2 = await renderHtml('# Document 2\n\n...') #### Options -Same as [`renderHtml()`](#renderhtml-options). +Same as [`renderHtml()`](#options). --- @@ -237,8 +237,8 @@ const html = await renderHtmlFromDocument(document) | Option | Type | Description | | --- | --- | --- | -| [`components`](#render-options-components) | `Record` | Custom component renderers | -| [`data`](#render-options-data) | `Record` | Data passed to component renderers | +| [`components`](#components) | `Record` | Custom component renderers | +| [`data`](#data) | `Record` | Data passed to component renderers | --- diff --git a/docs/content/3.rendering/3.vue.md b/docs/content/3.rendering/3.vue.md index 118d7b1f..d4a2e10d 100644 --- a/docs/content/3.rendering/3.vue.md +++ b/docs/content/3.rendering/3.vue.md @@ -49,7 +49,7 @@ The `` component is the quickest way to render markdown in Vue. It han `` is an **async** component and must always be wrapped in `` :: -For server-side rendering, use the [`MarkdownDocument`](#code-markdowndocument) component combined with parsing on the server instead. +For server-side rendering, use the [`MarkdownDocument`](#markdowndocument) component combined with parsing on the server instead. ```vue [App.vue]