cudoc-remark 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 cudoment
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,29 @@
+# cudoc-remark
+
+Connect cudoc Markdown syntax and prepared document embeds to a remark/MDX pipeline.
+
+This separate package is a pipeline adapter, not a second implementation of cudoc's rules. Shared document semantics live in `@cudoment/cudoc`. Use it directly with Next.js/remark; Docusaurus and Nextra adapters already depend on it. VitePress and HTML use their own adapters and do not need this plugin.
+
+ESM · Node.js 20+
+
+```sh
+npm install @cudoment/cudoc cudoc-remark remark-gfm
+```
+
+```js
+import remarkGfm from "remark-gfm"
+import cudoc from "cudoc-remark"
+
+const remarkPlugins = [remarkGfm, [cudoc, { host: "next", syntax: {} }]]
+```
+
+Default settings produce component-free output in both `.md` and `.mdx`; `syntax: {}` makes the defaults explicit. Let the host detect the document format. For Next.js Turbopack, use package-name plugin strings and JSON options as shown in the guide. `cudoc-remark/embed` inserts its runtime automatically after collection and preparation.
+
+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](https://github.com/cudoment/cudoc/tree/main/docs/next-mdx.md) · [한국어 가이드](https://github.com/cudoment/cudoc/tree/main/docs/next-mdx.ko.md)
+- [Markdown syntax](https://github.com/cudoment/cudoc/tree/main/docs/syntax.md)
+- [Embedding](https://github.com/cudoment/cudoc/tree/main/docs/embedding.md)
+- [Standalone HTML alongside a host](https://github.com/cudoment/cudoc/tree/main/docs/html.md#export-alongside-an-existing-site)
+- [API reference](https://github.com/cudoment/cudoc/tree/main/docs/api-reference/README.md)
+- [Runnable examples](https://github.com/cudoment/cudoc/tree/main/examples/README.md)

package/dist/capture.d.ts

@@ -0,0 +1,10 @@
+import type { Root } from "mdast";
+import type { Plugin } from "unified";
+import type { CompiledDocument } from "@cudoment/cudoc/markdown";
+/** Capture remark's final tree at the start of rehype, after native host plugins. */
+export declare function createCompilerCapture(): {
+    remark: Plugin<[], Root>;
+    rehype: Plugin;
+    read(): CompiledDocument;
+};
+//# sourceMappingURL=capture.d.ts.map

package/dist/capture.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"capture.d.ts","sourceRoot":"","sources":["../src/capture.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,OAAO,CAAA;AACjC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAErC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAEhE,qFAAqF;AACrF,wBAAgB,qBAAqB;;;YAyBzB,gBAAgB;EAQ3B"}

package/dist/capture.js

@@ -0,0 +1,33 @@
+import { lowerNativeElements } from "@cudoment/cudoc/document";
+/** Capture remark's final tree at the start of rehype, after native host plugins. */
+export function createCompilerCapture() {
+    let current;
+    let result;
+    const remark = () => (tree) => {
+        current = tree;
+    };
+    const rehype = () => (_tree, file) => {
+        if (!current)
+            throw new Error("cudoc: install capture.remark before capture.rehype");
+        const tree = structuredClone(current);
+        lowerNativeElements(tree);
+        tree.children = tree.children.filter((n) => !["yaml", "mdxjsEsm"].includes(n.type));
+        result = {
+            tree,
+            frontmatter: (file.data.frontMatter ??
+                file.data.frontmatter ??
+                {}),
+            diagnostics: [],
+        };
+    };
+    return {
+        remark,
+        rehype,
+        read() {
+            if (!result)
+                throw new Error("cudoc: host compilation did not reach the capture stage");
+            return result;
+        },
+    };
+}
+//# sourceMappingURL=capture.js.map

package/dist/capture.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"capture.js","sourceRoot":"","sources":["../src/capture.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAG9D,qFAAqF;AACrF,MAAM,UAAU,qBAAqB;IACnC,IAAI,OAAyB,CAAA;IAC7B,IAAI,MAAoC,CAAA;IACxC,MAAM,MAAM,GAAqB,GAAG,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE;QAC9C,OAAO,GAAG,IAAI,CAAA;IAChB,CAAC,CAAA;IACD,MAAM,MAAM,GAAW,GAAG,EAAE,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QAC3C,IAAI,CAAC,OAAO;YACV,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAA;QACxE,MAAM,IAAI,GAAG,eAAe,CAAC,OAAO,CAAC,CAAA;QACrC,mBAAmB,CAAC,IAAI,CAAC,CAAA;QACzB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAClC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAC9C,CAAA;QACD,MAAM,GAAG;YACP,IAAI;YACJ,WAAW,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW;gBACjC,IAAI,CAAC,IAAI,CAAC,WAAW;gBACrB,EAAE,CAA4B;YAChC,WAAW,EAAE,EAAE;SAChB,CAAA;IACH,CAAC,CAAA;IACD,OAAO;QACL,MAAM;QACN,MAAM;QACN,IAAI;YACF,IAAI,CAAC,MAAM;gBACT,MAAM,IAAI,KAAK,CACb,yDAAyD,CAC1D,CAAA;YACH,OAAO,MAAM,CAAA;QACf,CAAC;KACF,CAAA;AACH,CAAC"}

package/dist/components/index.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Default implementations of the elements cudoc emits.
+ *
+ * MDX destructures every capitalized element from the provided components and
+ * throws at render time when one is missing, so every name a configured feature
+ * can produce needs an implementation somewhere. These are that somewhere:
+ * plain markup with class names to hook styles onto, meant to be restyled or
+ * replaced rather than used as they are.
+ *
+ * Only two, because only two are genuinely new. A table laid out by a
+ * `tableColumnLayout` rule is rebuilt as `table`/`td` and friends, which every
+ * host already maps, so it needs nothing from here. A rule that names
+ * capitalized components instead is naming ones the site already has.
+ *
+ * They live next to the plugin that emits the elements so that the hosts do not
+ * each carry a copy and drift apart, and they are compiled to plain JavaScript
+ * rather than shipped as JSX because not every host transpiles inside
+ * `node_modules` — Docusaurus, for one, does not.
+ *
+ * `Anchor` renders only the badge. Its id belongs on the heading, put there by
+ * `cudoc-remark/heading-ids`: two elements sharing one id make a deep link
+ * ambiguous, and most hosts draw their own heading link. A site that does not
+ * promote heading ids has to supply an `Anchor` that renders the id itself.
+ */
+import type { ReactNode } from "react";
+export declare function Badge({ children }: {
+    children?: ReactNode;
+}): import("react").JSX.Element;
+export declare function Anchor({ badge }: {
+    badge?: string;
+}): import("react").JSX.Element | null;
+/** Every element a configured cudoc feature can emit, ready to spread. */
+export declare const cudocComponents: {
+    Anchor: typeof Anchor;
+    Badge: typeof Badge;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/components/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/components/index.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAEtC,wBAAgB,KAAK,CAAC,EAAE,QAAQ,EAAE,EAAE;IAAE,QAAQ,CAAC,EAAE,SAAS,CAAA;CAAE,+BAE3D;AAED,wBAAgB,MAAM,CAAC,EAAE,KAAK,EAAE,EAAE;IAAE,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,sCAEnD;AAED,0EAA0E;AAC1E,eAAO,MAAM,eAAe;;;CAG3B,CAAA"}

package/dist/components/index.js

@@ -0,0 +1,13 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+export function Badge({ children }) {
+    return _jsx("span", { className: "cudoc-badge", children: children });
+}
+export function Anchor({ badge }) {
+    return badge ? _jsx(Badge, { children: badge }) : null;
+}
+/** Every element a configured cudoc feature can emit, ready to spread. */
+export const cudocComponents = {
+    Anchor,
+    Badge,
+};
+//# sourceMappingURL=index.js.map

package/dist/components/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/components/index.tsx"],"names":[],"mappings":";AA2BA,MAAM,UAAU,KAAK,CAAC,EAAE,QAAQ,EAA4B;IAC1D,OAAO,eAAM,SAAS,EAAC,aAAa,YAAE,QAAQ,GAAQ,CAAA;AACxD,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,EAAE,KAAK,EAAsB;IAClD,OAAO,KAAK,CAAC,CAAC,CAAC,KAAC,KAAK,cAAE,KAAK,GAAS,CAAC,CAAC,CAAC,IAAI,CAAA;AAC9C,CAAC;AAED,0EAA0E;AAC1E,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,MAAM;IACN,KAAK;CACN,CAAA"}

package/dist/embed.d.ts

@@ -0,0 +1,9 @@
+import type { Root } from "mdast";
+import type { Plugin } from "unified";
+/** Render persisted embeds inside the current host compilation. */
+declare const embed: Plugin<[{
+    outDir?: string;
+    sourceRoot?: string;
+}?], Root>;
+export default embed;
+//# sourceMappingURL=embed.d.ts.map

package/dist/embed.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"embed.d.ts","sourceRoot":"","sources":["../src/embed.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,OAAO,CAAA;AACjC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AASrC,mEAAmE;AACnE,QAAA,MAAM,KAAK,EAAE,MAAM,CAAC,CAAC;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC,EAAE,IAAI,CA6ElE,CAAA;AACH,eAAe,KAAK,CAAA"}

package/dist/embed.js

@@ -0,0 +1,74 @@
+import path from "node:path";
+import { parse } from "acorn";
+import { readPreparedEmbeds, embedKey, } from "@cudoment/cudoc/node/prepare-embeds";
+/** Render persisted embeds inside the current host compilation. */
+const embed = (options = {}) => (tree, file) => {
+    let prepared;
+    let index = 0;
+    let usesEmbeds = false;
+    // One import per document makes the generated data a real bundler dependency.
+    // Rebuilding sources updates embeds.json even when the Markdown page is cached.
+    let relativeData = path
+        .relative(path.dirname(file.path), path.resolve(options.outDir ?? ".cudoc/documents", "embeds.json"))
+        .split(path.sep)
+        .join("/");
+    if (!relativeData.startsWith("."))
+        relativeData = `./${relativeData}`;
+    const documentId = path
+        .relative(path.resolve(options.sourceRoot ?? "docs"), file.path)
+        .split(path.sep)
+        .join("/")
+        .replace(/\.mdx?$/i, "");
+    const expand = (node) => {
+        if (!node.children)
+            return;
+        node.children = node.children.flatMap((child) => {
+            if (child.type === "code" && child.lang === "cudoc-embed") {
+                prepared ??= readPreparedEmbeds(options.outDir ?? ".cudoc/documents", documentId, String(file.value));
+                const result = prepared.blocks[embedKey(documentId, child.value, ++index)];
+                if (!result)
+                    throw new Error(`cudoc: prepared embed missing in ${documentId}; recollect documents`);
+                usesEmbeds = true;
+                const expression = `_cudocData.blocks[${JSON.stringify(embedKey(documentId, child.value, index))}]`;
+                return [
+                    {
+                        type: "mdxJsxFlowElement",
+                        name: "_CudocEmbed",
+                        attributes: [
+                            {
+                                type: "mdxJsxAttribute",
+                                name: "tree",
+                                value: {
+                                    type: "mdxJsxAttributeValueExpression",
+                                    value: expression,
+                                    data: {
+                                        estree: parse(expression, {
+                                            ecmaVersion: "latest",
+                                            sourceType: "module",
+                                        }),
+                                    },
+                                },
+                            },
+                        ],
+                        children: [],
+                    },
+                ];
+            }
+            expand(child);
+            return [child];
+        });
+    };
+    expand(tree);
+    if (usesEmbeds) {
+        const value = `import { EmbeddedDocument as _CudocEmbed } from "cudoc-remark/runtime";\nimport _cudocData from ${JSON.stringify(relativeData)};`;
+        tree.children.unshift({
+            type: "mdxjsEsm",
+            value,
+            data: {
+                estree: parse(value, { ecmaVersion: "latest", sourceType: "module" }),
+            },
+        });
+    }
+};
+export default embed;
+//# sourceMappingURL=embed.js.map

package/dist/embed.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"embed.js","sourceRoot":"","sources":["../src/embed.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAA;AAG5B,OAAO,EAAE,KAAK,EAAE,MAAM,OAAO,CAAA;AAE7B,OAAO,EACL,kBAAkB,EAClB,QAAQ,GAET,MAAM,qCAAqC,CAAA;AAE5C,mEAAmE;AACnE,MAAM,KAAK,GACT,CAAC,OAAO,GAAG,EAAE,EAAE,EAAE,CACjB,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;IACb,IAAI,QAAoC,CAAA;IACxC,IAAI,KAAK,GAAG,CAAC,CAAA;IACb,IAAI,UAAU,GAAG,KAAK,CAAA;IACtB,8EAA8E;IAC9E,gFAAgF;IAChF,IAAI,YAAY,GAAG,IAAI;SACpB,QAAQ,CACP,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EACvB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,IAAI,kBAAkB,EAAE,aAAa,CAAC,CAClE;SACA,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;SACf,IAAI,CAAC,GAAG,CAAC,CAAA;IACZ,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,YAAY,GAAG,KAAK,YAAY,EAAE,CAAA;IACrE,MAAM,UAAU,GAAG,IAAI;SACpB,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,IAAI,MAAM,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC;SAC/D,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;SACf,IAAI,CAAC,GAAG,CAAC;SACT,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAA;IAC1B,MAAM,MAAM,GAAG,CAAC,IAAkB,EAAE,EAAE;QACpC,IAAI,CAAC,IAAI,CAAC,QAAQ;YAAE,OAAM;QAC1B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC9C,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,IAAI,KAAK,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;gBAC1D,QAAQ,KAAK,kBAAkB,CAC7B,OAAO,CAAC,MAAM,IAAI,kBAAkB,EACpC,UAAU,EACV,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CACnB,CAAA;gBACD,MAAM,MAAM,GACV,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC,KAAM,EAAE,EAAE,KAAK,CAAC,CAAC,CAAA;gBAC9D,IAAI,CAAC,MAAM;oBACT,MAAM,IAAI,KAAK,CACb,oCAAoC,UAAU,uBAAuB,CACtE,CAAA;gBACH,UAAU,GAAG,IAAI,CAAA;gBACjB,MAAM,UAAU,GAAG,qBAAqB,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC,KAAM,EAAE,KAAK,CAAC,CAAC,GAAG,CAAA;gBACpG,OAAO;oBACL;wBACE,IAAI,EAAE,mBAAmB;wBACzB,IAAI,EAAE,aAAa;wBACnB,UAAU,EAAE;4BACV;gCACE,IAAI,EAAE,iBAAiB;gCACvB,IAAI,EAAE,MAAM;gCACZ,KAAK,EAAE;oCACL,IAAI,EAAE,gCAAgC;oCACtC,KAAK,EAAE,UAAU;oCACjB,IAAI,EAAE;wCACJ,MAAM,EAAE,KAAK,CAAC,UAAU,EAAE;4CACxB,WAAW,EAAE,QAAQ;4CACrB,UAAU,EAAE,QAAQ;yCACrB,CAAC;qCACH;iCACF;6BACF;yBACF;wBACD,QAAQ,EAAE,EAAE;qBACb;iBACF,CAAA;YACH,CAAC;YACD,MAAM,CAAC,KAAK,CAAC,CAAA;YACb,OAAO,CAAC,KAAK,CAAC,CAAA;QAChB,CAAC,CAAC,CAAA;IACJ,CAAC,CAAA;IACD,MAAM,CAAC,IAA+B,CAAC,CAAA;IACvC,IAAI,UAAU,EAAE,CAAC;QACf,MAAM,KAAK,GAAG,mGAAmG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,GAAG,CAAA;QAChJ,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;YACpB,IAAI,EAAE,UAAU;YAChB,KAAK;YACL,IAAI,EAAE;gBACJ,MAAM,EAAE,KAAK,CAAC,KAAK,EAAE,EAAE,WAAW,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC;aACtE;SACqC,CAAC,CAAA;IAC3C,CAAC;AACH,CAAC,CAAA;AACH,eAAe,KAAK,CAAA"}

package/dist/heading-ids.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Copies the id from a cudoc anchor onto the heading itself.
+ *
+ * A host that generates its own heading ids slugifies the heading text.
+ * Left alone that produces a second id beside cudoc's anchor, and a deep link
+ * resolves to whichever the browser finds first. Both Docusaurus and Nextra
+ * honour an id already sitting
+ * on `data.hProperties` — the property mdast-to-hast turns into the rendered
+ * attribute — so writing the anchor id there makes the heading and the anchor
+ * agree on one value.
+ *
+ * This runs as its own plugin rather than inside the single walk, because it
+ * has to sit between cudoc and the host's heading plugin, and the host decides
+ * where that is.
+ */
+import type { Root } from "mdast";
+import type { Plugin } from "unified";
+export type PromoteAnchorIdsOptions = {
+    /** Element name the id is read from. Matches `headingMetadata.anchor.name`. */
+    anchorName?: string;
+    /** Attribute the id is read from. Matches `headingMetadata.anchor.idAttribute`. */
+    idAttribute?: string;
+};
+export declare const promoteAnchorIds: Plugin<[PromoteAnchorIdsOptions?], Root>;
+export default promoteAnchorIds;
+//# sourceMappingURL=heading-ids.d.ts.map

package/dist/heading-ids.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"heading-ids.d.ts","sourceRoot":"","sources":["../src/heading-ids.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EAAW,IAAI,EAAE,MAAM,OAAO,CAAA;AAC1C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAQrC,MAAM,MAAM,uBAAuB,GAAG;IACpC,+EAA+E;IAC/E,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,mFAAmF;IACnF,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAOD,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,CAAC,uBAAuB,CAAC,CAAC,EAAE,IAAI,CAoBrE,CAAA;AAED,eAAe,gBAAgB,CAAA"}

package/dist/heading-ids.js

@@ -0,0 +1,35 @@
+/**
+ * Copies the id from a cudoc anchor onto the heading itself.
+ *
+ * A host that generates its own heading ids slugifies the heading text.
+ * Left alone that produces a second id beside cudoc's anchor, and a deep link
+ * resolves to whichever the browser finds first. Both Docusaurus and Nextra
+ * honour an id already sitting
+ * on `data.hProperties` — the property mdast-to-hast turns into the rendered
+ * attribute — so writing the anchor id there makes the heading and the anchor
+ * agree on one value.
+ *
+ * This runs as its own plugin rather than inside the single walk, because it
+ * has to sit between cudoc and the host's heading plugin, and the host decides
+ * where that is.
+ */
+import { visit } from "unist-util-visit";
+import { extractAnchorId, findAnchorNode, DEFAULT_ANCHOR_NAME, } from "@cudoment/cudoc";
+export const promoteAnchorIds = (options = {}) => {
+    const anchorName = options.anchorName ?? DEFAULT_ANCHOR_NAME;
+    const idAttribute = options.idAttribute ?? "id";
+    return (tree) => {
+        visit(tree, "heading", (heading) => {
+            const id = extractAnchorId(findAnchorNode(heading.children, anchorName), idAttribute);
+            if (!id)
+                return;
+            const data = (heading.data ?? (heading.data = {}));
+            const properties = data.hProperties ?? (data.hProperties = {});
+            // An id the author put there another way wins: this only fills a gap.
+            if (properties.id === undefined)
+                properties.id = id;
+        });
+    };
+};
+export default promoteAnchorIds;
+//# sourceMappingURL=heading-ids.js.map

package/dist/heading-ids.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"heading-ids.js","sourceRoot":"","sources":["../src/heading-ids.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAIH,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAA;AACxC,OAAO,EACL,eAAe,EACf,cAAc,EACd,mBAAmB,GACpB,MAAM,iBAAiB,CAAA;AAcxB,MAAM,CAAC,MAAM,gBAAgB,GAA6C,CACxE,OAAO,GAAG,EAAE,EACZ,EAAE;IACF,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,mBAAmB,CAAA;IAC5D,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,IAAI,CAAA;IAE/C,OAAO,CAAC,IAAU,EAAE,EAAE;QACpB,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,OAAgB,EAAE,EAAE;YAC1C,MAAM,EAAE,GAAG,eAAe,CACxB,cAAc,CAAC,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,EAC5C,WAAW,CACZ,CAAA;YACD,IAAI,CAAC,EAAE;gBAAE,OAAM;YAEf,MAAM,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,EAAE,CAAC,CAAgB,CAAA;YACjE,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC,CAAA;YAC9D,sEAAsE;YACtE,IAAI,UAAU,CAAC,EAAE,KAAK,SAAS;gBAAE,UAAU,CAAC,EAAE,GAAG,EAAE,CAAA;QACrD,CAAC,CAAC,CAAA;IACJ,CAAC,CAAA;AACH,CAAC,CAAA;AAED,eAAe,gBAAgB,CAAA"}

package/dist/host-plugins.d.ts

@@ -0,0 +1,18 @@
+/**
+ * The plugin list a host adapter hands to its site generator.
+ *
+ * Docusaurus and Nextra share the transforms and heading id promotion.
+ * Default output uses native elements without a cudoc component provider.
+ */
+import type { PluggableList } from "unified";
+import { type CudocRemarkOptions } from "./options.js";
+export type HostPluginOptions = Omit<CudocRemarkOptions, "toc"> & {
+    /**
+     * Copy each anchor id onto its heading so the host uses it instead of
+     * slugifying the heading text. On by default; turning it off leaves the
+     * host's ids and cudoc's anchors to disagree.
+     */
+    promoteHeadingIds?: boolean;
+};
+export declare const createHostPlugins: (options: HostPluginOptions | undefined, adapter: string) => PluggableList;
+//# sourceMappingURL=host-plugins.d.ts.map

package/dist/host-plugins.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"host-plugins.d.ts","sourceRoot":"","sources":["../src/host-plugins.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAE5C,OAAO,EAAkB,KAAK,kBAAkB,EAAE,MAAM,cAAc,CAAA;AAItE,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAAC,kBAAkB,EAAE,KAAK,CAAC,GAAG;IAChE;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAC5B,CAAA;AA6BD,eAAO,MAAM,iBAAiB,GAC5B,SAAS,iBAAiB,YAAK,EAC/B,SAAS,MAAM,KACd,aAkCF,CAAA"}

package/dist/host-plugins.js

@@ -0,0 +1,64 @@
+/**
+ * The plugin list a host adapter hands to its site generator.
+ *
+ * Docusaurus and Nextra share the transforms and heading id promotion.
+ * Default output uses native elements without a cudoc component provider.
+ */
+import cudocPrepare from "./prepare.js";
+import { resolveOptions } from "./options.js";
+import { promoteAnchorIds } from "./heading-ids.js";
+const KNOWN_KEYS = new Set([
+    "syntax",
+    "host",
+    "format",
+    "calloutTypes",
+    "components",
+    "headingIds",
+    "tableCellList",
+    "headingMetadata",
+    "badge",
+    "tableColumnLayout",
+    "transforms",
+    "promoteHeadingIds",
+]);
+/** Reads the anchor naming back out of the options the transforms were given. */
+const readAnchorNaming = (options) => {
+    const headingMetadata = options.headingMetadata;
+    if (!headingMetadata || headingMetadata === true)
+        return {};
+    return {
+        anchorName: headingMetadata.anchor?.name,
+        idAttribute: headingMetadata.anchor?.idAttribute,
+    };
+};
+export const createHostPlugins = (options = {}, adapter) => {
+    if (typeof options !== "object" || options === null) {
+        throw new TypeError(`${adapter}: options must be an object`);
+    }
+    for (const key of Object.keys(options)) {
+        if (!KNOWN_KEYS.has(key)) {
+            throw new TypeError(`${adapter}: unknown option "${key}"`);
+        }
+    }
+    const { promoteHeadingIds = true, ...remarkOptions } = options;
+    const host = adapter.includes("docusaurus")
+        ? "docusaurus"
+        : "nextra";
+    const resolvedOptions = {
+        ...remarkOptions,
+        host,
+        headingIds: "host",
+        toc: false,
+    };
+    // Resolved here rather than at the first document: a rejected key is a
+    // configuration mistake, and an error raised while the config loads is far
+    // easier to place than the same error raised from inside a loader.
+    resolveOptions(resolvedOptions);
+    const plugins = [[cudocPrepare, resolvedOptions]];
+    // After the transforms, which are what create the anchors it reads.
+    if (promoteHeadingIds) {
+        plugins.push([promoteAnchorIds, readAnchorNaming(remarkOptions)]);
+    }
+    return plugins;
+};
+//# sourceMappingURL=host-plugins.js.map

package/dist/host-plugins.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"host-plugins.js","sourceRoot":"","sources":["../src/host-plugins.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,YAAY,MAAM,cAAc,CAAA;AACvC,OAAO,EAAE,cAAc,EAA2B,MAAM,cAAc,CAAA;AACtE,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AAYnD,MAAM,UAAU,GAAG,IAAI,GAAG,CAAS;IACjC,QAAQ;IACR,MAAM;IACN,QAAQ;IACR,cAAc;IACd,YAAY;IACZ,YAAY;IACZ,eAAe;IACf,iBAAiB;IACjB,OAAO;IACP,mBAAmB;IACnB,YAAY;IACZ,mBAAmB;CACkB,CAAC,CAAA;AAExC,iFAAiF;AACjF,MAAM,gBAAgB,GAAG,CACvB,OAA2B,EACF,EAAE;IAC3B,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,CAAA;IAC/C,IAAI,CAAC,eAAe,IAAI,eAAe,KAAK,IAAI;QAAE,OAAO,EAAE,CAAA;IAC3D,OAAO;QACL,UAAU,EAAE,eAAe,CAAC,MAAM,EAAE,IAAI;QACxC,WAAW,EAAE,eAAe,CAAC,MAAM,EAAE,WAAW;KACjD,CAAA;AACH,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,UAA6B,EAAE,EAC/B,OAAe,EACA,EAAE;IACjB,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACpD,MAAM,IAAI,SAAS,CAAC,GAAG,OAAO,6BAA6B,CAAC,CAAA;IAC9D,CAAC;IACD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QACvC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,SAAS,CAAC,GAAG,OAAO,qBAAqB,GAAG,GAAG,CAAC,CAAA;QAC5D,CAAC;IACH,CAAC;IAED,MAAM,EAAE,iBAAiB,GAAG,IAAI,EAAE,GAAG,aAAa,EAAE,GAAG,OAAO,CAAA;IAC9D,MAAM,IAAI,GAA4B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC;QAClE,CAAC,CAAC,YAAY;QACd,CAAC,CAAC,QAAQ,CAAA;IACZ,MAAM,eAAe,GAAG;QACtB,GAAG,aAAa;QAChB,IAAI;QACJ,UAAU,EAAE,MAAe;QAC3B,GAAG,EAAE,KAAK;KACF,CAAA;IAEV,uEAAuE;IACvE,2EAA2E;IAC3E,mEAAmE;IACnE,cAAc,CAAC,eAAe,CAAC,CAAA;IAE/B,MAAM,OAAO,GAAkB,CAAC,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,CAAA;IAEhE,oEAAoE;IACpE,IAAI,iBAAiB,EAAE,CAAC;QACtB,OAAO,CAAC,IAAI,CAAC,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAA;IACnE,CAAC;IAED,OAAO,OAAO,CAAA;AAChB,CAAC,CAAA"}

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+export { default, default as cudocPrepare, buildTransforms, getFileSource, } from "./prepare.js";
+export { resolveOptions } from "./options.js";
+export type { CudocRemarkOptions, CudocState, FeatureOption, ResolvedCudocRemarkOptions, } from "./options.js";
+export { addTocExport, collectHeadingToc, createToc, resolveTocOptions, DEFAULT_TOC_EXPORT_NAME, } from "./toc.js";
+export type { Toc, TocEntry, TocHeading, TocOptions } from "./toc.js";
+export { createBadgeTransform, resolveBadgeOptions, DEFAULT_BADGE_NAME, } from "./transforms/badge.js";
+export type { BadgeOptions } from "./transforms/badge.js";
+export { transformTableCellList } from "./transforms/table-cell-list/index.js";
+export { createTableColumnLayoutTransform, resolveTableColumnLayoutOptions, } from "./transforms/table-column-layout/index.js";
+export type { TableColumnLayoutOptions } from "./transforms/table-column-layout/index.js";
+export { promoteAnchorIds } from "./heading-ids.js";
+export type { PromoteAnchorIdsOptions } from "./heading-ids.js";
+export { createHostPlugins } from "./host-plugins.js";
+export type { HostPluginOptions } from "./host-plugins.js";
+export { createCompilerCapture } from "./capture.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,OAAO,IAAI,YAAY,EACvB,eAAe,EACf,aAAa,GACd,MAAM,cAAc,CAAA;AACrB,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAC7C,YAAY,EACV,kBAAkB,EAClB,UAAU,EACV,aAAa,EACb,0BAA0B,GAC3B,MAAM,cAAc,CAAA;AACrB,OAAO,EACL,YAAY,EACZ,iBAAiB,EACjB,SAAS,EACT,iBAAiB,EACjB,uBAAuB,GACxB,MAAM,UAAU,CAAA;AACjB,YAAY,EAAE,GAAG,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AACrE,OAAO,EACL,oBAAoB,EACpB,mBAAmB,EACnB,kBAAkB,GACnB,MAAM,uBAAuB,CAAA;AAC9B,YAAY,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACzD,OAAO,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAA;AAC9E,OAAO,EACL,gCAAgC,EAChC,+BAA+B,GAChC,MAAM,2CAA2C,CAAA;AAClD,YAAY,EAAE,wBAAwB,EAAE,MAAM,2CAA2C,CAAA;AACzF,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AACnD,YAAY,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAA;AAC/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AACrD,YAAY,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA"}

package/dist/index.js

@@ -0,0 +1,10 @@
+export { default, default as cudocPrepare, buildTransforms, getFileSource, } from "./prepare.js";
+export { resolveOptions } from "./options.js";
+export { addTocExport, collectHeadingToc, createToc, resolveTocOptions, DEFAULT_TOC_EXPORT_NAME, } from "./toc.js";
+export { createBadgeTransform, resolveBadgeOptions, DEFAULT_BADGE_NAME, } from "./transforms/badge.js";
+export { transformTableCellList } from "./transforms/table-cell-list/index.js";
+export { createTableColumnLayoutTransform, resolveTableColumnLayoutOptions, } from "./transforms/table-column-layout/index.js";
+export { promoteAnchorIds } from "./heading-ids.js";
+export { createHostPlugins } from "./host-plugins.js";
+export { createCompilerCapture } from "./capture.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,OAAO,IAAI,YAAY,EACvB,eAAe,EACf,aAAa,GACd,MAAM,cAAc,CAAA;AACrB,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAO7C,OAAO,EACL,YAAY,EACZ,iBAAiB,EACjB,SAAS,EACT,iBAAiB,EACjB,uBAAuB,GACxB,MAAM,UAAU,CAAA;AAEjB,OAAO,EACL,oBAAoB,EACpB,mBAAmB,EACnB,kBAAkB,GACnB,MAAM,uBAAuB,CAAA;AAE9B,OAAO,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAA;AAC9E,OAAO,EACL,gCAAgC,EAChC,+BAA+B,GAChC,MAAM,2CAA2C,CAAA;AAElD,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AAEnD,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAErD,OAAO,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA"}

package/dist/options.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Option resolution.
+ *
+ * Every option here is JSON-serializable. A bundler may hand a plugin config to
+ * a worker, which rules out functions and `RegExp` objects, so syntax is
+ * described with delimiter pairs and conditions with declarative selectors.
+ * Behaviour that genuinely needs code goes in a custom transform instead.
+ *
+ * Unknown keys are rejected rather than ignored: a typo in a config that is
+ * silently dropped shows up much later as missing output.
+ */
+import { type HeadingMetadataOptions, type ResolvedHeadingMetadataOptions, type Transform, type TransformState } from "@cudoment/cudoc";
+import { type BadgeOptions, type ResolvedBadgeOptions } from "./transforms/badge.js";
+import { type ResolvedTableColumnLayoutOptions, type TableColumnLayoutOptions } from "./transforms/table-column-layout/index.js";
+import { type ResolvedTocOptions, type TocOptions } from "./toc.js";
+import type { Toc } from "./toc.js";
+import { type DocumentOptions } from "@cudoment/cudoc/document";
+export type CudocState = TransformState & {
+    toc: Toc;
+};
+/** A feature is off when `false`, on with defaults when `true` or omitted. */
+export type FeatureOption<Options> = boolean | Options | undefined;
+export type CudocRemarkOptions = Pick<DocumentOptions, "syntax" | "host" | "format" | "calloutTypes" | "components" | "headingIds"> & {
+    /** List syntax inside table cells. */
+    tableCellList?: boolean;
+    /** Anchor id and badge written in a heading. */
+    headingMetadata?: FeatureOption<HeadingMetadataOptions>;
+    /** Badge syntax in ordinary prose. */
+    badge?: FeatureOption<BadgeOptions>;
+    /** Table of contents collection and export. Off unless configured. */
+    toc?: FeatureOption<TocOptions>;
+    /** Column layout rules, applied in order. Empty by default. */
+    tableColumnLayout?: TableColumnLayoutOptions[];
+    /** Extra transforms, run alongside the built-in ones. */
+    transforms?: {
+        pre?: Transform<CudocState>[];
+        post?: Transform<CudocState>[];
+    };
+};
+export type ResolvedCudocRemarkOptions = {
+    tableCellList: boolean;
+    headingMetadata: ResolvedHeadingMetadataOptions | null;
+    badge: ResolvedBadgeOptions | null;
+    toc: ResolvedTocOptions | null;
+    tableColumnLayout: ResolvedTableColumnLayoutOptions[];
+    transforms: {
+        pre: Transform<CudocState>[];
+        post: Transform<CudocState>[];
+    };
+};
+export declare const resolveOptions: (options?: CudocRemarkOptions) => ResolvedCudocRemarkOptions;
+//# sourceMappingURL=options.d.ts.map

package/dist/options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAEL,KAAK,sBAAsB,EAC3B,KAAK,8BAA8B,EACnC,KAAK,SAAS,EACd,KAAK,cAAc,EACpB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAEL,KAAK,YAAY,EACjB,KAAK,oBAAoB,EAC1B,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EAEL,KAAK,gCAAgC,EACrC,KAAK,wBAAwB,EAC9B,MAAM,2CAA2C,CAAA;AAClD,OAAO,EAEL,KAAK,kBAAkB,EACvB,KAAK,UAAU,EAChB,MAAM,UAAU,CAAA;AACjB,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,UAAU,CAAA;AACnC,OAAO,EAAiB,KAAK,eAAe,EAAE,MAAM,0BAA0B,CAAA;AAE9E,MAAM,MAAM,UAAU,GAAG,cAAc,GAAG;IACxC,GAAG,EAAE,GAAG,CAAA;CACT,CAAA;AAED,8EAA8E;AAC9E,MAAM,MAAM,aAAa,CAAC,OAAO,IAAI,OAAO,GAAG,OAAO,GAAG,SAAS,CAAA;AAElE,MAAM,MAAM,kBAAkB,GAAG,IAAI,CACnC,eAAe,EACf,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,cAAc,GAAG,YAAY,GAAG,YAAY,CAC5E,GAAG;IACF,sCAAsC;IACtC,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,gDAAgD;IAChD,eAAe,CAAC,EAAE,aAAa,CAAC,sBAAsB,CAAC,CAAA;IACvD,sCAAsC;IACtC,KAAK,CAAC,EAAE,aAAa,CAAC,YAAY,CAAC,CAAA;IACnC,sEAAsE;IACtE,GAAG,CAAC,EAAE,aAAa,CAAC,UAAU,CAAC,CAAA;IAC/B,+DAA+D;IAC/D,iBAAiB,CAAC,EAAE,wBAAwB,EAAE,CAAA;IAC9C,yDAAyD;IACzD,UAAU,CAAC,EAAE;QACX,GAAG,CAAC,EAAE,SAAS,CAAC,UAAU,CAAC,EAAE,CAAA;QAC7B,IAAI,CAAC,EAAE,SAAS,CAAC,UAAU,CAAC,EAAE,CAAA;KAC/B,CAAA;CACF,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG;IACvC,aAAa,EAAE,OAAO,CAAA;IACtB,eAAe,EAAE,8BAA8B,GAAG,IAAI,CAAA;IACtD,KAAK,EAAE,oBAAoB,GAAG,IAAI,CAAA;IAClC,GAAG,EAAE,kBAAkB,GAAG,IAAI,CAAA;IAC9B,iBAAiB,EAAE,gCAAgC,EAAE,CAAA;IACrD,UAAU,EAAE;QACV,GAAG,EAAE,SAAS,CAAC,UAAU,CAAC,EAAE,CAAA;QAC5B,IAAI,EAAE,SAAS,CAAC,UAAU,CAAC,EAAE,CAAA;KAC9B,CAAA;CACF,CAAA;AA2CD,eAAO,MAAM,cAAc,GACzB,UAAS,kBAAuB,KAC/B,0BA+CF,CAAA"}

package/dist/options.js

@@ -0,0 +1,88 @@
+/**
+ * Option resolution.
+ *
+ * Every option here is JSON-serializable. A bundler may hand a plugin config to
+ * a worker, which rules out functions and `RegExp` objects, so syntax is
+ * described with delimiter pairs and conditions with declarative selectors.
+ * Behaviour that genuinely needs code goes in a custom transform instead.
+ *
+ * Unknown keys are rejected rather than ignored: a typo in a config that is
+ * silently dropped shows up much later as missing output.
+ */
+import { resolveHeadingMetadataOptions, } from "@cudoment/cudoc";
+import { resolveBadgeOptions, } from "./transforms/badge.js";
+import { resolveTableColumnLayoutOptions, } from "./transforms/table-column-layout/index.js";
+import { resolveTocOptions, } from "./toc.js";
+import { resolveSyntax } from "@cudoment/cudoc/document";
+const KNOWN_KEYS = new Set([
+    "syntax",
+    "host",
+    "format",
+    "calloutTypes",
+    "components",
+    "headingIds",
+    "tableCellList",
+    "headingMetadata",
+    "badge",
+    "toc",
+    "tableColumnLayout",
+    "transforms",
+]);
+const assertKnownKeys = (options) => {
+    const unknown = Object.keys(options).filter((key) => !KNOWN_KEYS.has(key));
+    if (unknown.length > 0) {
+        throw new TypeError(`cudoc: unknown option${unknown.length > 1 ? "s" : ""} ${unknown
+            .map((key) => `"${key}"`)
+            .join(", ")}. Known options: ${[...KNOWN_KEYS].join(", ")}`);
+    }
+};
+/**
+ * Resolves a feature that is on by default.
+ *
+ * `false` disables it, `true` or an absent value takes the defaults, and an
+ * object is the caller's configuration.
+ */
+const resolveFeature = (value, resolve) => {
+    if (value === false)
+        return null;
+    if (value === true || value === undefined)
+        return resolve();
+    return resolve(value);
+};
+export const resolveOptions = (options = {}) => {
+    if (typeof options !== "object" || options === null) {
+        throw new TypeError("cudoc: options must be an object");
+    }
+    assertKnownKeys(options);
+    if (options.syntax !== undefined) {
+        resolveSyntax(options.syntax);
+        for (const [feature, legacy] of [
+            ["headingAnchor", "headingMetadata"],
+            ["badge", "badge"],
+            ["tableCellList", "tableCellList"],
+        ]) {
+            if (options[legacy] !== undefined)
+                throw new TypeError(`cudoc: configure ${feature} through syntax or ${legacy}, not both`);
+        }
+    }
+    if (options.tableColumnLayout !== undefined &&
+        !Array.isArray(options.tableColumnLayout)) {
+        throw new TypeError("tableColumnLayout must be an array of rules");
+    }
+    return {
+        tableCellList: options.tableCellList !== false,
+        headingMetadata: resolveFeature(options.headingMetadata, resolveHeadingMetadataOptions),
+        badge: resolveFeature(options.badge, resolveBadgeOptions),
+        // A host usually builds its own table of contents, so this one stays off
+        // until it is asked for.
+        toc: options.toc === undefined || options.toc === false
+            ? null
+            : resolveFeature(options.toc, resolveTocOptions),
+        tableColumnLayout: (options.tableColumnLayout ?? []).map((rule, index) => resolveTableColumnLayoutOptions(rule, `tableColumnLayout[${index}]`)),
+        transforms: {
+            pre: options.transforms?.pre ?? [],
+            post: options.transforms?.post ?? [],
+        },
+    };
+};
+//# sourceMappingURL=options.js.map

package/dist/options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EACL,6BAA6B,GAK9B,MAAM,iBAAiB,CAAA;AACxB,OAAO,EACL,mBAAmB,GAGpB,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EACL,+BAA+B,GAGhC,MAAM,2CAA2C,CAAA;AAClD,OAAO,EACL,iBAAiB,GAGlB,MAAM,UAAU,CAAA;AAEjB,OAAO,EAAE,aAAa,EAAwB,MAAM,0BAA0B,CAAA;AA0C9E,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC;IACzB,QAAQ;IACR,MAAM;IACN,QAAQ;IACR,cAAc;IACd,YAAY;IACZ,YAAY;IACZ,eAAe;IACf,iBAAiB;IACjB,OAAO;IACP,KAAK;IACL,mBAAmB;IACnB,YAAY;CACb,CAAC,CAAA;AAEF,MAAM,eAAe,GAAG,CAAC,OAAe,EAAE,EAAE;IAC1C,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAA;IAC1E,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,SAAS,CACjB,wBAAwB,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,OAAO;aAC7D,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,GAAG,GAAG,CAAC;aACxB,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,GAAG,UAAU,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC9D,CAAA;IACH,CAAC;AACH,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,cAAc,GAAG,CACrB,KAA6B,EAC7B,OAAwC,EACvB,EAAE;IACnB,IAAI,KAAK,KAAK,KAAK;QAAE,OAAO,IAAI,CAAA;IAChC,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,OAAO,EAAE,CAAA;IAC3D,OAAO,OAAO,CAAC,KAAK,CAAC,CAAA;AACvB,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,UAA8B,EAAE,EACJ,EAAE;IAC9B,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACpD,MAAM,IAAI,SAAS,CAAC,kCAAkC,CAAC,CAAA;IACzD,CAAC;IACD,eAAe,CAAC,OAAO,CAAC,CAAA;IACxB,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QACjC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;QAC7B,KAAK,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI;YAC9B,CAAC,eAAe,EAAE,iBAAiB,CAAC;YACpC,CAAC,OAAO,EAAE,OAAO,CAAC;YAClB,CAAC,eAAe,EAAE,eAAe,CAAC;SAC1B,EAAE,CAAC;YACX,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,SAAS;gBAC/B,MAAM,IAAI,SAAS,CACjB,oBAAoB,OAAO,sBAAsB,MAAM,YAAY,CACpE,CAAA;QACL,CAAC;IACH,CAAC;IAED,IACE,OAAO,CAAC,iBAAiB,KAAK,SAAS;QACvC,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,EACzC,CAAC;QACD,MAAM,IAAI,SAAS,CAAC,6CAA6C,CAAC,CAAA;IACpE,CAAC;IAED,OAAO;QACL,aAAa,EAAE,OAAO,CAAC,aAAa,KAAK,KAAK;QAC9C,eAAe,EAAE,cAAc,CAC7B,OAAO,CAAC,eAAe,EACvB,6BAA6B,CAC9B;QACD,KAAK,EAAE,cAAc,CAAC,OAAO,CAAC,KAAK,EAAE,mBAAmB,CAAC;QACzD,yEAAyE;QACzE,yBAAyB;QACzB,GAAG,EACD,OAAO,CAAC,GAAG,KAAK,SAAS,IAAI,OAAO,CAAC,GAAG,KAAK,KAAK;YAChD,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG,EAAE,iBAAiB,CAAC;QACpD,iBAAiB,EAAE,CAAC,OAAO,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CACvE,+BAA+B,CAAC,IAAI,EAAE,qBAAqB,KAAK,GAAG,CAAC,CACrE;QACD,UAAU,EAAE;YACV,GAAG,EAAE,OAAO,CAAC,UAAU,EAAE,GAAG,IAAI,EAAE;YAClC,IAAI,EAAE,OAAO,CAAC,UAAU,EAAE,IAAI,IAAI,EAAE;SACrC;KACF,CAAA;AACH,CAAC,CAAA"}