cudoc-markdown-it

Connect cudoc Markdown syntax, document collection and embedding to a markdown-it pipeline.

This separate package is a pipeline adapter, not a second implementation of cudoc's rules. Shared document semantics live in @cudoment/cudoc. It is the markdown-it counterpart of cudoc-remark: the VitePress and Eleventy adapters depend on it, so the two hosts share one token conversion, one embed expansion and one collection path. Use it directly only when writing an adapter for another markdown-it host.

ESM · Node.js 20+

npm install @cudoment/cudoc cudoc-markdown-it

import { installHostPlugin, createHostCompiler } from "cudoc-markdown-it"

const host = {
  adapter: "cudoc-my-host",
  host: "markdown",
  documentId: (env) => String(env.documentId),
}

export default function cudocMyHost(md, options = {}) {
  installHostPlugin(md, options, host)
}
export const createDocumentCompiler = (md) => createHostCompiler(md, host)

The plugin converts the actual token stream and never parses the Markdown a second time. It reads the host's own anchor, link and container tokens, then copies the resolved heading ids and titles back onto the host tokens so native heading and TOC behavior is preserved. MarkdownItHost names everything a host does differently: its own tokens, the document id in its markdown-it env, whether it resolves links in renderer rules, and whether it strips front matter outside markdown-it.

Choose host, cudoc or both independently for headingAnchor, badge, tableCellList, callout and link. The representative callout is > [!NOTE] Title. Authors do not register cudoc React components in the recommended setup. Syntax-only rendering needs no stored JSON; cross-document embedding requires document collection.

• VitePress guide · Eleventy guide
• Markdown syntax
• Embedding
• Standalone HTML alongside a host
• API reference
• Runnable examples