cudoc-eleventy 0.3.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,38 @@
+# cudoc-eleventy
+
+Connect cudoc to Eleventy while retaining native heading IDs and TOC behavior.
+
+ESM · Node.js 20+
+
+```sh
+npm install @cudoment/cudoc cudoc-markdown-it cudoc-eleventy
+```
+
+```js
+import { createMarkdownRenderer } from "cudoc-eleventy"
+import attrs from "markdown-it-attrs"
+import anchor from "markdown-it-anchor"
+
+export default function (eleventyConfig) {
+  eleventyConfig.setLibrary(
+    "md",
+    createMarkdownRenderer({ syntax: { headingAnchor: "both" } }, (md) => {
+      md.use(attrs, { allowedAttributes: ["id"] })
+      md.use(anchor, { permalink: anchor.permalink.linkInsideHeader() })
+    }),
+  )
+  // cudoc reads source positions out of the token stream.
+  return { markdownTemplateEngine: false }
+}
+```
+
+Copy `@cudoment/cudoc/styles.css` into the output and link it from the layout. Eleventy accepts `.md`, not React `.mdx`. `createDocumentCompiler(md)` reuses the configured renderer for collection and replacements. Embedding requires a collected library and prepared data. Set `markdownTemplateEngine: false` so markdown-it receives the file's own text, and insert heading permalinks inside the heading rather than wrapping it. This adapter shares `cudoc-markdown-it` with `cudoc-vitepress` and does not use `cudoc-remark`.
+
+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/eleventy.md) · [한국어 가이드](https://github.com/cudoment/cudoc/tree/main/docs/eleventy.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/index.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Eleventy adapter.
+ *
+ * The arrangement itself is `installHostPlugin`, shared with the VitePress
+ * adapter through `cudoc-markdown-it`, so the two markdown-it hosts cannot
+ * quietly diverge. What is specific to Eleventy is described in the host
+ * definition below: it passes the page data object as the markdown-it env, and
+ * it strips front matter with gray-matter before markdown-it ever sees the
+ * source, so collection has to strip it the same way.
+ *
+ * Eleventy runs Liquid over Markdown before markdown-it by default. cudoc reads
+ * source positions out of the token stream, so a site using cudoc must set
+ * `markdownTemplateEngine: false`; the plugin raises an error when it detects
+ * that the source it received is not the file's own text.
+ */
+import type MarkdownIt from "markdown-it";
+import { type HostPluginOptions } from "cudoc-markdown-it";
+import type { DocumentCompiler } from "@cudoment/cudoc/node/library";
+export type EleventyOptions = HostPluginOptions;
+/**
+ * Install on the markdown-it instance handed to `eleventyConfig.setLibrary`.
+ *
+ * Register the site's own markdown-it plugins first so their tokens already
+ * exist when cudoc reads the stream.
+ */
+export default function cudocEleventy(md: MarkdownIt, options?: EleventyOptions): void;
+/**
+ * One markdown-it construction for both the Eleventy build and the collector.
+ *
+ * Eleventy's own defaults are applied first: HTML enabled, and indented code
+ * blocks disabled, which is what Eleventy does to every renderer it is given.
+ * `configure` receives the instance before cudoc is installed, which is where
+ * `markdown-it-attrs` and `markdown-it-container` belong.
+ */
+export declare function createMarkdownRenderer(options?: EleventyOptions, configure?: (md: MarkdownIt) => void): MarkdownIt;
+/** Reuse the very same configured Eleventy renderer for collection and source replacements. */
+export declare function createDocumentCompiler(md: MarkdownIt): DocumentCompiler;
+//# 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;;;;;;;;;;;;;;GAcG;AAGH,OAAO,KAAK,UAAU,MAAM,aAAa,CAAA;AAEzC,OAAO,EAGL,KAAK,iBAAiB,EAEvB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAA;AAEpE,MAAM,MAAM,eAAe,GAAG,iBAAiB,CAAA;AAqC/C;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,aAAa,CACnC,EAAE,EAAE,UAAU,EACd,OAAO,GAAE,eAAoB,GAC5B,IAAI,CASN;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CACpC,OAAO,GAAE,eAAoB,EAC7B,SAAS,CAAC,EAAE,CAAC,EAAE,EAAE,UAAU,KAAK,IAAI,GACnC,UAAU,CAMZ;AAED,+FAA+F;AAC/F,wBAAgB,sBAAsB,CAAC,EAAE,EAAE,UAAU,GAAG,gBAAgB,CAEvE"}

package/dist/index.js

@@ -0,0 +1,75 @@
+/**
+ * Eleventy adapter.
+ *
+ * The arrangement itself is `installHostPlugin`, shared with the VitePress
+ * adapter through `cudoc-markdown-it`, so the two markdown-it hosts cannot
+ * quietly diverge. What is specific to Eleventy is described in the host
+ * definition below: it passes the page data object as the markdown-it env, and
+ * it strips front matter with gray-matter before markdown-it ever sees the
+ * source, so collection has to strip it the same way.
+ *
+ * Eleventy runs Liquid over Markdown before markdown-it by default. cudoc reads
+ * source positions out of the token stream, so a site using cudoc must set
+ * `markdownTemplateEngine: false`; the plugin raises an error when it detects
+ * that the source it received is not the file's own text.
+ */
+import markdownIt from "markdown-it";
+import matter from "gray-matter";
+import { installHostPlugin, createHostCompiler, } from "cudoc-markdown-it";
+const readPage = (env) => {
+    const page = env.page;
+    if (typeof page !== "object" || page === null)
+        throw new Error('cudoc-eleventy: the markdown-it env carries no Eleventy page data; install the renderer with eleventyConfig.setLibrary("md", md)');
+    return page;
+};
+const eleventy = {
+    adapter: "cudoc-eleventy",
+    host: "eleventy",
+    documentId: (env) => {
+        const { filePathStem } = readPage(env);
+        if (typeof filePathStem !== "string")
+            throw new Error("cudoc-eleventy: page.filePathStem is required to identify the collected document");
+        return filePathStem.replace(/^\//, "");
+    },
+    compilerEnv: ({ id, filePath }) => ({
+        page: { inputPath: filePath, filePathStem: `/${id}` },
+    }),
+    frontmatter: (source) => {
+        const parsed = matter(source);
+        return { body: parsed.content, data: parsed.data };
+    },
+};
+/**
+ * Install on the markdown-it instance handed to `eleventyConfig.setLibrary`.
+ *
+ * Register the site's own markdown-it plugins first so their tokens already
+ * exist when cudoc reads the stream.
+ */
+export default function cudocEleventy(md, options = {}) {
+    installHostPlugin(md, options, eleventy);
+    md.core.ruler.before("cudoc", "cudoc-eleventy-source", (state) => {
+        const raw = state.env.page?.rawInput;
+        if (typeof raw === "string" && raw !== state.src)
+            throw new Error("cudoc-eleventy: another template engine rewrote this Markdown before markdown-it; set markdownTemplateEngine: false");
+    });
+}
+/**
+ * One markdown-it construction for both the Eleventy build and the collector.
+ *
+ * Eleventy's own defaults are applied first: HTML enabled, and indented code
+ * blocks disabled, which is what Eleventy does to every renderer it is given.
+ * `configure` receives the instance before cudoc is installed, which is where
+ * `markdown-it-attrs` and `markdown-it-container` belong.
+ */
+export function createMarkdownRenderer(options = {}, configure) {
+    const md = markdownIt({ html: true });
+    md.disable("code");
+    configure?.(md);
+    md.use(cudocEleventy, options);
+    return md;
+}
+/** Reuse the very same configured Eleventy renderer for collection and source replacements. */
+export function createDocumentCompiler(md) {
+    return createHostCompiler(md, eleventy);
+}
+//# 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;;;;;;;;;;;;;;GAcG;AAEH,OAAO,UAAU,MAAM,aAAa,CAAA;AAEpC,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,EACL,iBAAiB,EACjB,kBAAkB,GAGnB,MAAM,mBAAmB,CAAA;AAW1B,MAAM,QAAQ,GAAG,CAAC,GAA4B,EAAgB,EAAE;IAC9D,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAA;IACrB,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI;QAC3C,MAAM,IAAI,KAAK,CACb,kIAAkI,CACnI,CAAA;IACH,OAAO,IAAoB,CAAA;AAC7B,CAAC,CAAA;AAED,MAAM,QAAQ,GAAmB;IAC/B,OAAO,EAAE,gBAAgB;IACzB,IAAI,EAAE,UAAU;IAChB,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE;QAClB,MAAM,EAAE,YAAY,EAAE,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAA;QACtC,IAAI,OAAO,YAAY,KAAK,QAAQ;YAClC,MAAM,IAAI,KAAK,CACb,kFAAkF,CACnF,CAAA;QACH,OAAO,YAAY,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;IACxC,CAAC;IACD,WAAW,EAAE,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;QAClC,IAAI,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,EAAE;KACtD,CAAC;IACF,WAAW,EAAE,CAAC,MAAM,EAAE,EAAE;QACtB,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAA;QAC7B,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAA;IACpD,CAAC;CACF,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,aAAa,CACnC,EAAc,EACd,UAA2B,EAAE;IAE7B,iBAAiB,CAAC,EAAE,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAA;IACxC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,uBAAuB,EAAE,CAAC,KAAK,EAAE,EAAE;QAC/D,MAAM,GAAG,GAAI,KAAK,CAAC,GAA+B,CAAC,IAAI,EAAE,QAAQ,CAAA;QACjE,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,KAAK,CAAC,GAAG;YAC9C,MAAM,IAAI,KAAK,CACb,qHAAqH,CACtH,CAAA;IACL,CAAC,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,sBAAsB,CACpC,UAA2B,EAAE,EAC7B,SAAoC;IAEpC,MAAM,EAAE,GAAG,UAAU,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAA;IACrC,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IAClB,SAAS,EAAE,CAAC,EAAE,CAAC,CAAA;IACf,EAAE,CAAC,GAAG,CAAC,aAAa,EAAE,OAAO,CAAC,CAAA;IAC9B,OAAO,EAAE,CAAA;AACX,CAAC;AAED,+FAA+F;AAC/F,MAAM,UAAU,sBAAsB,CAAC,EAAc;IACnD,OAAO,kBAAkB,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAA;AACzC,CAAC"}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "cudoc-eleventy",
+  "version": "0.3.0",
+  "description": "Eleventy Markdown integration for cudoc",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cudoment/cudoc.git",
+    "directory": "packages/cudoc-eleventy"
+  },
+  "homepage": "https://github.com/cudoment/cudoc/tree/main/packages/cudoc-eleventy#readme",
+  "bugs": {
+    "url": "https://github.com/cudoment/cudoc/issues"
+  },
+  "keywords": [
+    "cudoc",
+    "eleventy",
+    "11ty",
+    "markdown",
+    "documentation"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "clean": "rm -rf dist *.tsbuildinfo"
+  },
+  "dependencies": {
+    "@cudoment/cudoc": "0.3.0",
+    "cudoc-markdown-it": "0.3.0",
+    "gray-matter": "^4.0.3"
+  },
+  "peerDependencies": {
+    "@11ty/eleventy": "^3.0.0",
+    "markdown-it": "^14.1.0"
+  },
+  "devDependencies": {
+    "@types/markdown-it": "^14.2.0"
+  },
+  "author": "cudoment",
+  "engines": {
+    "node": ">=20"
+  }
+}