cudoc-docusaurus

Connect cudoc to Docusaurus while retaining native heading IDs and TOC behavior.

ESM · Node.js 20+

npm install @cudoment/cudoc cudoc-remark cudoc-docusaurus

import { cudocRemarkPlugins } from "cudoc-docusaurus"

// In the Docusaurus docs plugin options:
const docs = {
  beforeDefaultRemarkPlugins: cudocRemarkPlugins({
    syntax: { headingAnchor: "both", callout: "both" },
  }),
}

Use markdown.format: "detect" for .md and .mdx. Import @cudoment/cudoc/styles.css from site CSS. The explicit syntax setup needs no cudoc theme plugin or component registration. For embedding, use the actual Docusaurus compiler during collection and add cudoc-remark/embed afterward in the rendering pipeline.

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.

• Usage guide · 한국어 가이드
• Markdown syntax
• Embedding
• Standalone HTML alongside a host
• API reference
• Runnable examples