Skip to content

docs: clean up AI-written prose in docs and comments - #609

Merged
farnabaz merged 4 commits into
mainfrom
docs/clean-up-prose-and-comments
Nov 18, 2026
Merged

farnabaz merged 4 commits into
mainfrom
docs/clean-up-prose-and-comments

Conversation

@atinux

@atinux atinux commented Nov 18, 2026 •

Copy link
Copy Markdown
Contributor

Written by an AI agent on behalf of @atinux.

What

Strips AI-generated prose patterns, brochure vocabulary, decorative emoji bullets, and narrated code comments across 344 documentation and source files (+3,571 / -5,996 lines), fixes stale paths and version references uncovered during the audit, and tightens AGENTS.md from 1,102 lines down to 336 lines. Runtime logic, public TypeScript signatures, test assertions, and SPEC/ fixtures are untouched.

Why

Generated prose and comments had accumulated across older docs pages, package README.mds, AGENTS.md, and source files: 467 em dashes across Markdown and code comments, 44 ASCII section divider banners, line-by-line narrated comments that buried real security and parser invariants, copied ::code-explorer frontmatter in GitHub-rendered examples/**/README.md files, and stale paths and Angular version numbers. Cleaning these in one pass aligns older docs with the direct style introduced in #477, reduces .d.ts and README.md weight in published tarballs, and cuts AGENTS.md context overhead by 70%.

Evidence

Metric main (before) This branch (after)
Em dashes in Markdown docs (162 files, excluding SPEC/) 242 4 (literal punctuation plugin output examples only)
Em dashes in code comments 225 0
ASCII section divider banners in code comments 44 0
AGENTS.md lines 1,102 336
comark unpacked tarball (npm pack --dry-run) 444k (173 files) 439k (173 files)
@comark/vue / @comark/svelte / @comark/angular tarballs 62.8k / 51.2k / 70.0k 62.5k / 50.8k / 69.7k

Verification runs on this branch (all exit code 0):

$ pnpm lint && pnpm typecheck
$ oxlint . && oxfmt --check . && pnpm --filter comark-docs-site lint
Checking formatting...

All matched files use the correct format.
Finished in 300ms on 680 files using 4 threads.
$ comark-lint "content/**/*.md"
No problems.
$ tsc --noEmit
  • pnpm test: comark (71 files, 2,111 passed, 4 skipped), @comark/html (76 passed), @comark/ansi (118 passed), @comark/vue (120 passed), @comark/react server + Chromium (90 passed), @comark/svelte server + Chromium (144 passed), @comark/angular (74 passed), exit code 0.
  • pnpm test:sanitizer: 2 files, 437 passed, exit code 0.
  • pnpm prepack && pnpm vitest run test/bundle.test.ts: 1 file, 2 passed, exit code 0.

Details

  • Preserved intentionally: Frontmatter SEO title and seo.title casing from docs: SEO and AEO pass (positioning, titles, llms.txt, use cases, comparisons) #477, smart-typography output examples in punctuation.md and vue-vite-punctuation, Made with ❤️ footers in README.md files, // #region folding markers, Twoslash // ---cut--- directives, @ts-expect-error checks, and all SPEC/ and test/sanitizer/fixtures/ test inputs.
  • Bundle snapshot: test/bundle.test.ts is updated in this PR because TypeScript emits exported JSDoc comments into .d.ts files and npm pack includes each package's README.md.
  • Visual rendering: Not captured with screenshots in this PR; comark-lint verified all Comark components, links, and heading anchors across docs/content/**/*.md, and the docs preview workflow builds the site on CI.

ELI5

Over time, AI-assisted edits left robotic phrasing, decorative emojis, and obvious step-by-step comments scattered across Comark's documentation and source code. This change rewrites those docs in plain English, deletes comments that only repeat what the next line of code already says, and fixes outdated links and version numbers we found along the way. No code behavior changed, and the published packages are slightly smaller because the extra comment text is gone.

Walkthrough

Documentation, skills, and READMEs

  • Rewrote essay puffery (such as docs/content/7.kb/0.why-comark.md), "not just X, but Y" framing, trailing -ing commentary clauses, reader-dismissive words (simply, easily), Latin abbreviations (e.g., i.e.), em dashes, and brochure vocabulary (seamless, crucial, first-class, out of the box, under the hood, battle-tested).
  • Removed decorative emoji bullet prefixes in packages/*/README.md and docs/skills/comark/SKILL.md.
  • Converted all 21 examples/**/README.md files from copied docs-site ::code-explorer frontmatter into plain GitHub Flavored Markdown so they render properly on GitHub.
  • Updated stale Angular 17+ references to Angular 21+, added @comark/angular to SECURITY.md, updated /api/parse and 5.api/ links to /reference/..., and fixed MDC-era bare binding examples and broken relative links in docs/README.md and docs/skills/.

Code comments, JSDoc, and bundle snapshot

  • Deleted line-by-line narrated comments (// Check if we start with $$, // Handle text nodes, // Set inputs), ASCII section divider banners, dead commented-out code, diff-talk phrasing ((the previous behavior)), and signature-restating @param tags in packages/comark/src/types.ts.
  • Kept comments that document security threats, DoS bounds, O(n) / allocation constraints, framework SSR quirks, and CommonMark/GFM/MDC spec subtleties, rewriting their punctuation to plain ASCII.
  • Updated the unpacked tarball size snapshot in test/bundle.test.ts.

Agent instructions (AGENTS.md)

  • Consolidated three overlapping copies of package import snippets into one Package exports reference section and removed generic Vitest tutorials.
  • Fixed stale repository paths: removed nonexistent playground/ and .release-it.json notes, updated packages/comark/src/internal/ (parse/tree.ts instead of token-processor.ts; src/plugins/linkify.ts for linkify-it), corrected @comark/angular's component layout and sync-plugins.mjs export generation, and added 7.kb/, 8.examples/, 9.ecosystem.md, and docs/skills/ to the docs map.

@atinux
atinux requested a review from farnabaz as a code owner November 18, 2026 13:39
@coldtea-pr-lens

Copy link
Copy Markdown

Note

The title starts with docs:, so PR Lens left this pull request undrawn. Comment @pr-lens draw to draw it

github.comment.notice: false in .github/pr-lens.yml turns this note off

@vercel

vercel Bot commented Nov 18, 2026 •

Copy link
Copy Markdown

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

9 Skipped Deployments
Project Deployment Actions Updated
comark Ignored Ignored Preview Nov 18, 2026 2:22pm UTC
comark-binding Skipped Skipped Nov 18, 2026 2:22pm UTC
comark-json-render Skipped Skipped Nov 18, 2026 2:22pm UTC
comark-nextjs Skipped Skipped Nov 18, 2026 2:22pm UTC
comark-nuxt Skipped Skipped Nov 18, 2026 2:22pm UTC
comark-svelte Skipped Skipped Nov 18, 2026 2:22pm UTC
comark-sveltekit Skipped Skipped Nov 18, 2026 2:22pm UTC
comark-twoslash Skipped Skipped Nov 18, 2026 2:22pm UTC
comark-vue Skipped Skipped Nov 18, 2026 2:22pm UTC

@github-actions

github-actions Bot commented Nov 18, 2026 •

Copy link
Copy Markdown
Contributor

Documentation previews

📚 Preview all documentation changes (follows new pushes)

Pinned to the current head: 2b66bc0

@coderabbitai

coderabbitai Bot commented Nov 18, 2026 •

Copy link
Copy Markdown
Contributor

Important

Review skipped

Too many files!

This PR contains 345 files, which is 195 over the limit of 150.

To get a review, reduce the PR to 150 files or fewer by splitting it into smaller PRs or changing its base branch.

Upgrade to a paid plan to raise the limit.

Usage-priced reviews support at most 300 files.

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 580ee667-834f-473b-bab8-3062fb0e75f5
Commits

Reviewing files that changed from the base of the PR and between b26abba and 2b66bc0.

Files selected for processing: 345

  • AGENTS.md
  • SECURITY.md
  • benchmarks/comark-parse.ts
  • benchmarks/comark-render.ts
  • benchmarks/fixtures.ts
  • benchmarks/plugin-highlight.ts
  • benchmarks/plugin-punctuation.ts
  • docs/README.md
  • docs/app/components/Editor.vue
  • docs/app/components/Playground.vue
  • docs/app/components/prose/EcosystemList.vue
  • docs/app/components/prose/LandingStreamingDemo.vue
  • docs/app/composables/stringToStream.ts
  • docs/app/composables/useMDCStream.ts
  • docs/app/pages/stream.vue
  • docs/app/utils/components-manifest.ts
  • docs/content/1.getting-started/0.introduction.md
  • docs/content/1.getting-started/1.installation.md
  • docs/content/1.getting-started/2.document-model.md
  • docs/content/10.use-cases/1.intelligent-ui.md
  • docs/content/10.use-cases/10.email-and-rss.md
  • docs/content/10.use-cases/2.ai-chat-streaming.md
  • docs/content/10.use-cases/3.vue-ai-chat.md
  • docs/content/10.use-cases/4.svelte-ai-chat.md
  • docs/content/10.use-cases/5.angular-ai-chat.md
  • docs/content/10.use-cases/6.generative-ui.md
  • docs/content/10.use-cases/7.docs-and-blogs.md
  • docs/content/10.use-cases/8.cms-runtime-content.md
  • docs/content/10.use-cases/9.cli-and-agents.md
  • docs/content/10.use-cases/index.md
  • docs/content/11.compare/0.markdown-libraries-for-ai-chat.md
  • docs/content/11.compare/1.comark-vs-mdx.md
  • docs/content/11.compare/10.comark-vs-svelte-markdown.md
  • docs/content/11.compare/11.comark-vs-vue-markdown-render.md
  • docs/content/11.compare/2.comark-vs-react-markdown.md
  • docs/content/11.compare/3.comark-vs-streamdown.md
  • docs/content/11.compare/4.comark-vs-markdoc.md
  • docs/content/11.compare/5.comark-vs-markstream.md
  • docs/content/11.compare/6.comark-vs-marked.md
  • docs/content/11.compare/7.comark-vs-markdown-it.md
  • docs/content/11.compare/8.comark-vs-remark.md
  • docs/content/11.compare/9.comark-vs-markdown-to-jsx.md
  • docs/content/11.compare/index.md
  • docs/content/2.syntax/1.markdown.md
  • docs/content/2.syntax/2.components.md
  • docs/content/2.syntax/3.attributes.md
  • docs/content/2.syntax/4.frontmatter.md
  • docs/content/3.rendering/2.html.md
  • docs/content/3.rendering/3.vue.md
  • docs/content/3.rendering/5.react.md
  • docs/content/3.rendering/6.svelte.md
  • docs/content/3.rendering/7.angular.md
  • docs/content/3.rendering/8.ansi.md
  • docs/content/4.plugins/0.defaults/alert.md
  • docs/content/4.plugins/0.defaults/attributes.md
  • docs/content/4.plugins/0.defaults/components.md
  • docs/content/4.plugins/0.defaults/frontmatter.md
  • docs/content/4.plugins/0.defaults/html.md
  • docs/content/4.plugins/0.defaults/linkify.md
  • docs/content/4.plugins/0.defaults/task-list.md
  • docs/content/4.plugins/1.built-in/binding.md
  • docs/content/4.plugins/1.built-in/breaks.md
  • docs/content/4.plugins/1.built-in/emoji.md
  • docs/content/4.plugins/1.built-in/external-links.md
  • docs/content/4.plugins/1.built-in/footnotes.md
  • docs/content/4.plugins/1.built-in/heading-links.md
  • docs/content/4.plugins/1.built-in/json-render.md
  • docs/content/4.plugins/1.built-in/math.md
  • docs/content/4.plugins/1.built-in/mermaid.md
  • docs/content/4.plugins/1.built-in/punctuation.md
  • docs/content/4.plugins/1.built-in/rangi.md
  • docs/content/4.plugins/1.built-in/security.md
  • docs/content/4.plugins/1.built-in/shiki.md
  • docs/content/4.plugins/1.built-in/summary.md
  • docs/content/4.plugins/1.built-in/title-description.md
  • docs/content/4.plugins/1.built-in/toc.md
  • docs/content/4.plugins/2.custom/1.plugin-api.md
  • docs/content/4.plugins/2.custom/2.ast-api.md
  • docs/content/4.plugins/2.custom/3.markdown-it.md
  • docs/content/4.plugins/index.md
  • docs/content/5.reference/0.render.md
  • docs/content/5.reference/1.parse.md
  • docs/content/5.reference/2.auto-close.md
  • docs/content/5.reference/3.reference.md
  • docs/content/7.kb/0.why-comark.md
  • docs/content/7.kb/2.migration-from-mdc.md
  • docs/content/7.kb/3.migration-from-mdx.md
  • docs/content/7.kb/4.twoslash.md
  • docs/content/7.kb/5.custom-code-block.md
  • docs/content/8.examples/1.frameworks/astro.md
  • docs/content/8.examples/1.frameworks/nextjs.md
  • docs/content/8.examples/1.frameworks/nuxt.md
  • docs/content/8.examples/1.frameworks/sveltekit.md
  • docs/content/8.examples/1.frameworks/vitepress.md
  • docs/content/8.examples/2.vite/angular.md
  • docs/content/8.examples/2.vite/html.md
  • docs/content/8.examples/2.vite/react.md
  • docs/content/8.examples/2.vite/svelte.md
  • docs/content/8.examples/2.vite/vue.md
  • docs/content/8.examples/3.plugins/react-vite-math.md
  • docs/content/8.examples/3.plugins/react-vite-mermaid.md
  • docs/content/8.examples/3.plugins/vue-vite-binding.md
  • docs/content/8.examples/3.plugins/vue-vite-highlight.md
  • docs/content/8.examples/3.plugins/vue-vite-json-render.md
  • docs/content/8.examples/3.plugins/vue-vite-math.md
  • docs/content/8.examples/3.plugins/vue-vite-mermaid.md
  • docs/content/8.examples/3.plugins/vue-vite-punctuation.md
  • docs/content/8.examples/4.ai/nuxt-ai-sdk.md
  • docs/content/8.examples/index.md
  • docs/content/9.ecosystem.md
  • docs/content/index.md
  • docs/nuxt.config.ts
  • docs/server/api/generate-page.post.ts
  • docs/server/utils/llms.ts
  • docs/skills/comark/AGENTS.md
  • docs/skills/comark/SKILL.md
  • docs/skills/comark/references/markdown-syntax.md
  • docs/skills/comark/references/parsing-ast.md
  • docs/skills/comark/references/rendering-angular.md
  • docs/skills/comark/references/rendering-react.md
  • docs/skills/comark/references/rendering-svelte.md
  • docs/skills/comark/references/rendering-vue.md
  • docs/skills/migrate-mdc-to-comark/SKILL.md
  • examples/1.frameworks/astro/README.md
  • examples/1.frameworks/astro/src/content/posts/astro-integration.md
  • examples/1.frameworks/astro/src/content/posts/comark-syntax.md
  • examples/1.frameworks/astro/src/content/posts/hello-world.md
  • examples/1.frameworks/nextjs/README.md
  • examples/1.frameworks/nextjs/content/posts/comark-syntax.md
  • examples/1.frameworks/nextjs/content/posts/hello-world.md
  • examples/1.frameworks/nextjs/content/posts/nextjs-integration.md
  • examples/1.frameworks/nuxt/README.md
  • examples/1.frameworks/nuxt/content/posts/comark-syntax.md
  • examples/1.frameworks/nuxt/content/posts/hello-world.md
  • examples/1.frameworks/nuxt/content/posts/nuxt-ui-integration.md
  • examples/1.frameworks/sveltekit/README.md
  • examples/1.frameworks/vitepress/README.md
  • examples/1.frameworks/vitepress/demo.md
  • examples/1.frameworks/vitepress/index.md
  • examples/2.vite/angular/README.md
  • examples/2.vite/angular/content/posts/angular-integration.md
  • examples/2.vite/angular/content/posts/comark-syntax.md
  • examples/2.vite/angular/content/posts/hello-world.md
  • examples/2.vite/angular/src/app/components/feature-card.component.ts
  • examples/2.vite/angular/src/app/pages/live.component.ts
  • examples/2.vite/angular/vite.config.ts
  • examples/2.vite/ansi/src/main.ts
  • examples/2.vite/html/README.md
  • examples/2.vite/react/README.md
  • examples/2.vite/react/content/posts/comark-syntax.md
  • examples/2.vite/react/content/posts/hello-world.md
  • examples/2.vite/react/content/posts/react-integration.md
  • examples/2.vite/react/src/pages/Live.tsx
  • examples/2.vite/svelte/README.md
  • examples/2.vite/svelte/content/posts/comark-syntax.md
  • examples/2.vite/svelte/content/posts/hello-world.md
  • examples/2.vite/svelte/content/posts/svelte-integration.md
  • examples/2.vite/svelte/src/pages/Live.svelte
  • examples/2.vite/vue-streaming/README.md
  • examples/2.vite/vue-streaming/src/App.vue
  • examples/2.vite/vue-streaming/src/misrender.ts
  • examples/2.vite/vue/README.md
  • examples/2.vite/vue/content/posts/comark-syntax.md
  • examples/2.vite/vue/content/posts/hello-world.md
  • examples/2.vite/vue/content/posts/vue-integration.md
  • examples/2.vite/vue/src/pages/live.vue
  • examples/3.cli/ansi/source.md
  • examples/3.plugins/react-vite-math/README.md
  • examples/3.plugins/react-vite-mermaid/README.md
  • examples/3.plugins/vue-vite-binding/README.md
  • examples/3.plugins/vue-vite-highlight/README.md
  • examples/3.plugins/vue-vite-highlight/src/App.vue
  • examples/3.plugins/vue-vite-json-render/README.md
  • examples/3.plugins/vue-vite-json-render/src/App.vue
  • examples/3.plugins/vue-vite-math/README.md
  • examples/3.plugins/vue-vite-mermaid/README.md
  • examples/3.plugins/vue-vite-punctuation/README.md
  • examples/3.plugins/vue-vite-rangi/README.md
  • examples/3.plugins/vue-vite-twoslash/src/App.vue
  • examples/4.ai/nuxt-ai-sdk/README.md
  • packages/comark-angular/README.md
  • packages/comark-angular/plugins/math/math.component.ts
  • packages/comark-angular/plugins/mermaid/mermaid.component.ts
  • packages/comark-angular/src/components/markdown-document.component.ts
  • packages/comark-angular/src/components/markdown-node.component.ts
  • packages/comark-angular/src/components/markdown.component.ts
  • packages/comark-angular/src/define.ts
  • packages/comark-angular/src/utils/caret.ts
  • packages/comark-angular/test/nested-components.test.ts
  • packages/comark-angular/test/parse.test.ts
  • packages/comark-angular/test/rendering.test.ts
  • packages/comark-ansi/README.md
  • packages/comark-ansi/src/handlers/li.ts
  • packages/comark-ansi/src/handlers/pre.ts
  • packages/comark-ansi/src/handlers/table.ts
  • packages/comark-ansi/src/plugins/math.ts
  • packages/comark-ansi/src/render.ts
  • packages/comark-ansi/test/index.test.ts
  • packages/comark-ansi/test/plugin-binding.test.ts
  • packages/comark-html/README.md
  • packages/comark-html/src/plugins/math.ts
  • packages/comark-html/src/plugins/mermaid.ts
  • packages/comark-html/test/index.test.ts
  • packages/comark-html/test/plugin-fallbacks.test.ts
  • packages/comark-nuxt/README.md
  • packages/comark-react/README.md
  • packages/comark-react/src/components/Markdown.tsx
  • packages/comark-react/src/components/MarkdownClient.tsx
  • packages/comark-react/src/components/MarkdownDocument.tsx
  • packages/comark-react/src/components/MarkdownLive.tsx
  • packages/comark-react/src/components/Math.tsx
  • packages/comark-react/src/components/Mermaid.tsx
  • packages/comark-react/src/index.ts
  • packages/comark-react/src/utils/caret.ts
  • packages/comark-react/test/define-component.test.tsx
  • packages/comark-react/test/plugin-math.test.tsx
  • packages/comark-react/test/plugin-mermaid.test.tsx
  • packages/comark-react/test/renderer-error-handling.test.tsx
  • packages/comark-react/test/renderer-slots.test.tsx
  • packages/comark-react/test/unwrap.test.tsx
  • packages/comark-svelte/README.md
  • packages/comark-svelte/src/components/Markdown.svelte
  • packages/comark-svelte/src/components/MarkdownDocument.svelte
  • packages/comark-svelte/src/components/MarkdownNode.svelte
  • packages/comark-svelte/src/types.ts
  • packages/comark-svelte/test/MarkdownNode.test.ts
  • packages/comark-svelte/test/markdown-document-value.test.ts
  • packages/comark-svelte/test/math/index.test.ts
  • packages/comark-svelte/test/mermaid/index.svelte.test.ts
  • packages/comark-svelte/test/mermaid/index.test.ts
  • packages/comark-svelte/test/renderer-data-binding.svelte.test.ts
  • packages/comark-vue/README.md
  • packages/comark-vue/src/components/Markdown.ts
  • packages/comark-vue/src/components/MarkdownDocument.ts
  • packages/comark-vue/src/components/Math.ts
  • packages/comark-vue/src/components/Mermaid.ts
  • packages/comark-vue/src/index.ts
  • packages/comark-vue/src/utils/caret.ts
  • packages/comark-vue/src/vite.ts
  • packages/comark-vue/test/define-component.test.ts
  • packages/comark-vue/test/node.test.ts
  • packages/comark-vue/test/renderer-data-binding.test.ts
  • packages/comark-vue/test/renderer-error-handling.test.ts
  • packages/comark-vue/test/renderer-slots.test.ts
  • packages/comark-vue/test/slot.test.ts
  • packages/comark-vue/test/unwrap.test.ts
  • packages/comark/README.md
  • packages/comark/src/auto-close.ts
  • packages/comark/src/context.ts
  • packages/comark/src/core.ts
  • packages/comark/src/index.ts
  • packages/comark/src/internal/entities.ts
  • packages/comark/src/internal/frontmatter.ts
  • packages/comark/src/internal/heading-id.ts
  • packages/comark/src/internal/inline-code-lang.ts
  • packages/comark/src/internal/parse/indent.ts
  • packages/comark/src/internal/parse/syntax/props.ts
  • packages/comark/src/internal/parse/tree-utils.ts
  • packages/comark/src/internal/parse/tree.ts
  • packages/comark/src/internal/parse/unwrap.ts
  • packages/comark/src/internal/parse/utils.ts
  • packages/comark/src/internal/sanitize.ts
  • packages/comark/src/internal/shiki.ts
  • packages/comark/src/internal/stringify/attributes.ts
  • packages/comark/src/internal/stringify/handlers/blockquote.ts
  • packages/comark/src/internal/stringify/handlers/component.ts
  • packages/comark/src/internal/stringify/handlers/heading.ts
  • packages/comark/src/internal/stringify/handlers/html.ts
  • packages/comark/src/internal/stringify/handlers/li.ts
  • packages/comark/src/internal/stringify/handlers/math.ts
  • packages/comark/src/internal/stringify/handlers/mdc.ts
  • packages/comark/src/internal/stringify/handlers/mermaid.ts
  • packages/comark/src/internal/stringify/handlers/ol.ts
  • packages/comark/src/internal/stringify/handlers/pre.ts
  • packages/comark/src/internal/stringify/handlers/table.ts
  • packages/comark/src/internal/stringify/handlers/template.ts
  • packages/comark/src/internal/stringify/handlers/ul.ts
  • packages/comark/src/internal/stringify/html-attributes.ts
  • packages/comark/src/internal/stringify/link.ts
  • packages/comark/src/internal/stringify/state.ts
  • packages/comark/src/internal/yaml.ts
  • packages/comark/src/plugins/alert.ts
  • packages/comark/src/plugins/attributes.ts
  • packages/comark/src/plugins/binding.ts
  • packages/comark/src/plugins/components.ts
  • packages/comark/src/plugins/emoji.ts
  • packages/comark/src/plugins/footnotes.ts
  • packages/comark/src/plugins/frontmatter.ts
  • packages/comark/src/plugins/heading-links.ts
  • packages/comark/src/plugins/html.ts
  • packages/comark/src/plugins/json-render.ts
  • packages/comark/src/plugins/math.ts
  • packages/comark/src/plugins/mermaid.ts
  • packages/comark/src/plugins/punctuation.ts
  • packages/comark/src/plugins/rangi.ts
  • packages/comark/src/plugins/rangi/language-comark.ts
  • packages/comark/src/plugins/security.ts
  • packages/comark/src/plugins/shiki/core.ts
  • packages/comark/src/plugins/task-list.ts
  • packages/comark/src/plugins/title-description.ts
  • packages/comark/src/render/html.ts
  • packages/comark/src/render/index.ts
  • packages/comark/src/types.ts
  • packages/comark/src/utils/caret.ts
  • packages/comark/src/utils/helpers.ts
  • packages/comark/src/utils/index.ts
  • packages/comark/src/utils/trace.ts
  • packages/comark/test/_types/_plugin-declare.ts
  • packages/comark/test/auto-close-spec.test.ts
  • packages/comark/test/auto-close.test.ts
  • packages/comark/test/auto-unwrap-integration.test.ts
  • packages/comark/test/auto-unwrap.test.ts
  • packages/comark/test/compare-parsers.test.ts
  • packages/comark/test/component-name.test.ts
  • packages/comark/test/context.test.ts
  • packages/comark/test/dos.test.ts
  • packages/comark/test/empty-props.test.ts
  • packages/comark/test/fence.test.ts
  • packages/comark/test/footnotes.test.ts
  • packages/comark/test/heading-ids.test.ts
  • packages/comark/test/html-block.test.ts
  • packages/comark/test/html-escape.test.ts
  • packages/comark/test/index.test.ts
  • packages/comark/test/inline-component-content.test.ts
  • packages/comark/test/inline-component-roundtrip.test.ts
  • packages/comark/test/nested-component-blank-lines.test.ts
  • packages/comark/test/parse/sub-sup.test.ts
  • packages/comark/test/perf.test.ts
  • packages/comark/test/playground-scenario.test.ts
  • packages/comark/test/plugins/binding.test.ts
  • packages/comark/test/plugins/default-plugins.test.ts
  • packages/comark/test/plugins/rangi.test.ts
  • packages/comark/test/plugins/security.test.ts
  • packages/comark/test/plugins/title-description.test.ts
  • packages/comark/test/punctuation.test.ts
  • packages/comark/test/roundtrip-safety.test.ts
  • packages/comark/test/sanitize.test.ts
  • packages/comark/test/spec-runner.mjs
  • packages/comark/test/streaming.test.ts
  • packages/comark/test/text-escape.test.ts
  • packages/comark/test/visit.test.ts
  • scripts/stub.mjs
  • scripts/sync-plugins.mjs
  • test/bundle.test.ts
  • test/sanitizer/url-cases.test.ts

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

  • 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

@pkg-pr-new

pkg-pr-new Bot commented Nov 18, 2026 •

Copy link
Copy Markdown

Open in StackBlitz

comark

npm i https://pkg.pr.new/comark@609

@comark/angular

npm i https://pkg.pr.new/@comark/angular@609

@comark/ansi

npm i https://pkg.pr.new/@comark/ansi@609

@comark/html

npm i https://pkg.pr.new/@comark/html@609

@comark/nuxt

npm i https://pkg.pr.new/@comark/nuxt@609

@comark/react

npm i https://pkg.pr.new/@comark/react@609

@comark/svelte

npm i https://pkg.pr.new/@comark/svelte@609

@comark/vue

npm i https://pkg.pr.new/@comark/vue@609

commit: 2b66bc0

@codspeed

codspeed Bot commented Nov 18, 2026 •

Copy link
Copy Markdown

Merging this PR will not alter performance

✅ 43 untouched benchmarks


Comparing docs/clean-up-prose-and-comments (2b66bc0) with main (b26abba)

Open in CodSpeed

@vercel
vercel Bot temporarily deployed to Preview – comark-json-render November 18, 2026 14:22 Inactive
@vercel
vercel Bot temporarily deployed to Preview – comark-sveltekit November 18, 2026 14:22 Inactive
@vercel
vercel Bot temporarily deployed to Preview – comark-nuxt November 18, 2026 14:22 Inactive
@vercel
vercel Bot temporarily deployed to Preview – comark-vue November 18, 2026 14:22 Inactive
@vercel
vercel Bot temporarily deployed to Preview – comark-binding November 18, 2026 14:22 Inactive
@vercel
vercel Bot temporarily deployed to Preview – comark-svelte November 18, 2026 14:22 Inactive
@vercel
vercel Bot temporarily deployed to Preview – comark-nextjs November 18, 2026 14:22 Inactive
@vercel
vercel Bot temporarily deployed to Preview – comark-twoslash November 18, 2026 14:22 Inactive
@atinux
atinux requested a review from farnabaz November 18, 2026 14:26

@farnabaz farnabaz left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, Thanks

@farnabaz
farnabaz merged commit 6360b11 into main Nov 18, 2026
18 checks passed
@farnabaz
farnabaz deleted the docs/clean-up-prose-and-comments branch November 18, 2026 14:51
@github-actions github-actions Bot mentioned this pull request Nov 18, 2026

This branch was previously deployed

8 inactive deployments
Preview – comark-twoslash — 2b66bc02 Deployed Nov 18, 2026 by vercel[bot]
Preview – comark-sveltekit — 2b66bc02 Deployed Nov 18, 2026 by vercel[bot]
Preview – comark-nuxt — 2b66bc02 Deployed Nov 18, 2026 by vercel[bot]
Preview – comark-vue — 2b66bc02 Deployed Nov 18, 2026 by vercel[bot]
Preview – comark-binding — 2b66bc02 Deployed Nov 18, 2026 by vercel[bot]
Preview – comark-svelte — 2b66bc02 Deployed Nov 18, 2026 by vercel[bot]
Preview – comark-nextjs — 2b66bc02 Deployed Nov 18, 2026 by vercel[bot]
Preview – comark-json-render — 2b66bc02 Deployed Nov 18, 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.

2 participants