comark-plugins

Plugins for review documents, built on Comark. This is an independent project by @onmax, not made by the Comark team. Each package is published on its own and all of them share one version.

Package	What it does
comark-annotate	Hand-drawn marks, numbered notes, and arrows on screenshots, and before/after comparisons.
comark-badge	Badges for versions and statuses, inline as :badge[deprecated]{color="warning"} or as Nuxt UI's block ::badge, in Nuxt UI's seven colors.
comark-cards	Cards, link cards, and columns in Nuxt UI's syntax, with no script.
comark-carousel	A carousel of any Markdown content, with arrows, a counter, keys, and zoom.
comark-charts	Charts from Markdown tables.
comark-chips	Links and @user mentions as chips with the site's favicon or the person's avatar, inlined while parsing.
comark-code	Copy and Wrap buttons on code blocks, and buttons of your own that hand the code to your app.
comark-deflist	Definition lists: a term, then : definition lines, rendered as native <dl>, <dt>, and <dd>.
comark-details	Details, accordions, and collapsibles in Nuxt UI's syntax, drawn as native <details> with a real <summary>, so they open with no script.
comark-diff	A code change shown like a suggested change in a pull request review: the file, red and green lines, and the words that changed.
comark-embed	YouTube, Vimeo, Loom, Spotify, CodePen, StackBlitz, and Figma players from a link, with no network fetch.
comark-figure	Image captions: an image alone in its paragraph with a title becomes a native <figure> with a <figcaption>.
comark-file-tree	A project's folders and files from an indented list or pasted tree output, with added, removed, and changed entries marked and a note on any line.
comark-fields	Props, options, and parameters in Nuxt UI's ::field syntax, with their types, defaults, and an object's properties nested under it.
comark-github	GitHub's > [!NOTE] alerts as callouts, @user and #123 as links, and raw HTML limited to what GitHub allows.
comark-icon	Iconify icons in Markdown as :icon{name="lucide:apple"}, drawn as CSS with no script, and the resolver other plugins draw icons with.
comark-media	Videos and audio written as images, and GitHub attachment links that play, with no script.
comark-linter	Finds unclosed blocks, unknown components, broken links and anchors, local URLs, and plugin issues in Comark documents, from a script, the command line, or Vite Doctor.
comark-include	Markdown partials and code snippets from files, by lines or by region.
comark-mark	==highlighted text== as <mark> and ^superscript^ as <sup>.
comark-steps	Numbered steps from the headings of a tutorial or a numbered list, in Nuxt UI's ::steps syntax, with no script.
comark-qr	QR codes drawn as inline SVG while parsing, for opening a preview link on a phone.
comark-reading-time	A document's word count and reading time in meta.readingTime, with code blocks left out and CJK counted by character.
comark-tabs	Tabs and code groups that switch together across the page, and read without a script.
comark-outline	A table of contents in the body of a page: ::toc becomes a nested list of links to its headings.
comark-zoom	Zoom images and any block like medium-zoom, with Escape, Back, and click-outside to close.

Docs and live demos: comark.onmax.me.

Develop

pnpm install
pnpm ready      # format, lint, typecheck, build, test, and Vite Doctor
pnpm docs:build # the docs site in docs/dist

Each package keeps its docs pages next to its code, in packages/<name>/docs/, and docs/build.ts renders them into the site with the pages in docs/pages/. test/workspace.test.ts lists everywhere a new package has to be registered.