@dogsbay/format-mkdocs 0.2.0-beta.0

package/dist/inline-walker.js

@@ -0,0 +1,167 @@
+/**
+ * Convert markdown-it inline token children into structured InlineNode[].
+ */
+export function walkInlineTokens(tokens) {
+    if (!tokens || tokens.length === 0)
+        return [];
+    const result = [];
+    const annotations = { bold: false, italic: false, strikethrough: false };
+    // Stack for container elements (links)
+    // When inside a link, spans are pushed to the link's children instead of result
+    const containerStack = [];
+    function target() {
+        if (containerStack.length > 0) {
+            return containerStack[containerStack.length - 1].node.children;
+        }
+        return result;
+    }
+    function pushNode(node) {
+        target().push(node);
+    }
+    function makeText(text) {
+        const span = { type: "text", text };
+        if (annotations.bold)
+            span.bold = true;
+        if (annotations.italic)
+            span.italic = true;
+        if (annotations.strikethrough)
+            span.strikethrough = true;
+        return span;
+    }
+    for (let i = 0; i < tokens.length; i++) {
+        const token = tokens[i];
+        switch (token.type) {
+            // ── Annotation open/close ──
+            case "strong_open":
+                annotations.bold = true;
+                break;
+            case "strong_close":
+                annotations.bold = false;
+                break;
+            case "em_open":
+                annotations.italic = true;
+                break;
+            case "em_close":
+                annotations.italic = false;
+                break;
+            case "s_open":
+                annotations.strikethrough = true;
+                break;
+            case "s_close":
+                annotations.strikethrough = false;
+                break;
+            // ── Link container ──
+            case "link_open": {
+                const href = token.attrGet("href") || "";
+                const title = token.attrGet("title") || undefined;
+                const linkNode = { type: "link", href, children: [] };
+                if (title)
+                    linkNode.title = title;
+                containerStack.push({ type: "link", node: linkNode });
+                break;
+            }
+            case "link_close": {
+                const container = containerStack.pop();
+                if (container) {
+                    // Push the completed link to the parent target
+                    target().push(container.node);
+                }
+                break;
+            }
+            // ── Text ──
+            case "text": {
+                if (token.content) {
+                    pushNode(makeText(token.content));
+                }
+                break;
+            }
+            // ── Inline code ──
+            case "code_inline": {
+                const codeNode = { type: "code", text: token.content };
+                pushNode(codeNode);
+                break;
+            }
+            // ── Image ──
+            case "image": {
+                const src = token.attrGet("src") || "";
+                const alt = token.content || token.attrGet("alt") || undefined;
+                const title = token.attrGet("title") || undefined;
+                const imgNode = { type: "image", src };
+                if (alt)
+                    imgNode.alt = alt;
+                if (title)
+                    imgNode.title = title;
+                pushNode(imgNode);
+                break;
+            }
+            // ── Footnote reference (custom rule) ──
+            case "footnote_ref": {
+                const label = token.meta?.label || "";
+                const fnNode = { type: "footnote-ref", label };
+                pushNode(fnNode);
+                break;
+            }
+            // ── Line breaks ──
+            case "softbreak": {
+                // Soft break is just whitespace (newline within a paragraph)
+                pushNode(makeText(" "));
+                break;
+            }
+            case "hardbreak": {
+                const brNode = { type: "break" };
+                pushNode(brNode);
+                break;
+            }
+            // ── Inline math ──
+            case "math_inline": {
+                const mathNode = { type: "math", latex: token.content || token.meta?.latex || "" };
+                pushNode(mathNode);
+                break;
+            }
+            // ── Icon/emoji shortcode ──
+            case "icon_shortcode": {
+                const meta = token.meta || {};
+                const iconNode = {
+                    type: "icon",
+                    name: meta.name || meta.raw || "",
+                    library: meta.library,
+                };
+                if (meta.variant)
+                    iconNode.variant = meta.variant;
+                if (meta.size)
+                    iconNode.size = meta.size;
+                if (meta.attrs)
+                    iconNode.attrs = meta.attrs;
+                pushNode(iconNode);
+                break;
+            }
+            // ── Raw HTML inline (escape hatch) ──
+            case "html_inline": {
+                // Try to detect <kbd> patterns from keys plugin
+                const kbdMatch = token.content.match(/^<kbd>([^<]+)<\/kbd>(?:\+<kbd>([^<]+)<\/kbd>)*$/);
+                if (kbdMatch) {
+                    const keys = token.content
+                        .match(/<kbd>([^<]+)<\/kbd>/g)
+                        .map((m) => m.replace(/<\/?kbd>/g, ""));
+                    const kbdNode = { type: "kbd", keys };
+                    pushNode(kbdNode);
+                }
+                else {
+                    const htmlNode = { type: "html-inline", html: token.content };
+                    pushNode(htmlNode);
+                }
+                break;
+            }
+            // ── Fallback: anything else becomes html-inline ──
+            default: {
+                if (token.content) {
+                    const htmlNode = { type: "html-inline", html: token.content };
+                    pushNode(htmlNode);
+                }
+                break;
+            }
+        }
+    }
+    return result;
+}
+//# sourceMappingURL=inline-walker.js.map

package/dist/inline-walker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inline-walker.js","sourceRoot":"","sources":["../src/inline-walker.ts"],"names":[],"mappings":"AA+BA;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAsB;IACrD,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IAE9C,MAAM,MAAM,GAAiB,EAAE,CAAC;IAChC,MAAM,WAAW,GAAgB,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC;IAEtF,uCAAuC;IACvC,gFAAgF;IAChF,MAAM,cAAc,GAAyC,EAAE,CAAC;IAEhE,SAAS,MAAM;QACb,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9B,OAAO,cAAc,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;QACjE,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,SAAS,QAAQ,CAAC,IAAgB;QAChC,MAAM,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtB,CAAC;IAED,SAAS,QAAQ,CAAC,IAAY;QAC5B,MAAM,IAAI,GAAe,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;QAChD,IAAI,WAAW,CAAC,IAAI;YAAE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACvC,IAAI,WAAW,CAAC,MAAM;YAAE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QAC3C,IAAI,WAAW,CAAC,aAAa;YAAE,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QACzD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACvC,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QAExB,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;YACnB,8BAA8B;YAC9B,KAAK,aAAa;gBAChB,WAAW,CAAC,IAAI,GAAG,IAAI,CAAC;gBACxB,MAAM;YACR,KAAK,cAAc;gBACjB,WAAW,CAAC,IAAI,GAAG,KAAK,CAAC;gBACzB,MAAM;YACR,KAAK,SAAS;gBACZ,WAAW,CAAC,MAAM,GAAG,IAAI,CAAC;gBAC1B,MAAM;YACR,KAAK,UAAU;gBACb,WAAW,CAAC,MAAM,GAAG,KAAK,CAAC;gBAC3B,MAAM;YACR,KAAK,QAAQ;gBACX,WAAW,CAAC,aAAa,GAAG,IAAI,CAAC;gBACjC,MAAM;YACR,KAAK,SAAS;gBACZ,WAAW,CAAC,aAAa,GAAG,KAAK,CAAC;gBAClC,MAAM;YAER,uBAAuB;YACvB,KAAK,WAAW,CAAC,CAAC,CAAC;gBACjB,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;gBACzC,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,SAAS,CAAC;gBAClD,MAAM,QAAQ,GAAe,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;gBAClE,IAAI,KAAK;oBAAE,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC;gBAClC,cAAc,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;gBACtD,MAAM;YACR,CAAC;YACD,KAAK,YAAY,CAAC,CAAC,CAAC;gBAClB,MAAM,SAAS,GAAG,cAAc,CAAC,GAAG,EAAE,CAAC;gBACvC,IAAI,SAAS,EAAE,CAAC;oBACd,+CAA+C;oBAC/C,MAAM,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;gBAChC,CAAC;gBACD,MAAM;YACR,CAAC;YAED,aAAa;YACb,KAAK,MAAM,CAAC,CAAC,CAAC;gBACZ,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;oBAClB,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;gBACpC,CAAC;gBACD,MAAM;YACR,CAAC;YAED,oBAAoB;YACpB,KAAK,aAAa,CAAC,CAAC,CAAC;gBACnB,MAAM,QAAQ,GAAe,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;gBACnE,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBACnB,MAAM;YACR,CAAC;YAED,cAAc;YACd,KAAK,OAAO,CAAC,CAAC,CAAC;gBACb,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;gBACvC,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,SAAS,CAAC;gBAC/D,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,SAAS,CAAC;gBAClD,MAAM,OAAO,GAAgB,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC;gBACpD,IAAI,GAAG;oBAAE,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC;gBAC3B,IAAI,KAAK;oBAAE,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC;gBACjC,QAAQ,CAAC,OAAO,CAAC,CAAC;gBAClB,MAAM;YACR,CAAC;YAED,yCAAyC;YACzC,KAAK,cAAc,CAAC,CAAC,CAAC;gBACpB,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;gBACtC,MAAM,MAAM,GAAsB,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC;gBAClE,QAAQ,CAAC,MAAM,CAAC,CAAC;gBACjB,MAAM;YACR,CAAC;YAED,oBAAoB;YACpB,KAAK,WAAW,CAAC,CAAC,CAAC;gBACjB,6DAA6D;gBAC7D,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;gBACxB,MAAM;YACR,CAAC;YACD,KAAK,WAAW,CAAC,CAAC,CAAC;gBACjB,MAAM,MAAM,GAAgB,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;gBAC9C,QAAQ,CAAC,MAAM,CAAC,CAAC;gBACjB,MAAM;YACR,CAAC;YAED,oBAAoB;YACpB,KAAK,aAAa,CAAC,CAAC,CAAC;gBACnB,MAAM,QAAQ,GAAe,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE,EAAE,CAAC;gBAC/F,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBACnB,MAAM;YACR,CAAC;YAED,6BAA6B;YAC7B,KAAK,gBAAgB,CAAC,CAAC,CAAC;gBACtB,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;gBAC9B,MAAM,QAAQ,GAAe;oBAC3B,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,GAAG,IAAI,EAAE;oBACjC,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB,CAAC;gBACF,IAAI,IAAI,CAAC,OAAO;oBAAE,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;gBAClD,IAAI,IAAI,CAAC,IAAI;oBAAE,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;gBACzC,IAAI,IAAI,CAAC,KAAK;oBAAE,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;gBAC5C,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBACnB,MAAM;YACR,CAAC;YAED,uCAAuC;YACvC,KAAK,aAAa,CAAC,CAAC,CAAC;gBACnB,gDAAgD;gBAChD,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAClC,iDAAiD,CAClD,CAAC;gBACF,IAAI,QAAQ,EAAE,CAAC;oBACb,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO;yBACvB,KAAK,CAAC,sBAAsB,CAAE;yBAC9B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC;oBAC1C,MAAM,OAAO,GAAc,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;oBACjD,QAAQ,CAAC,OAAO,CAAC,CAAC;gBACpB,CAAC;qBAAM,CAAC;oBACN,MAAM,QAAQ,GAAe,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;oBAC1E,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBACrB,CAAC;gBACD,MAAM;YACR,CAAC;YAED,oDAAoD;YACpD,OAAO,CAAC,CAAC,CAAC;gBACR,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;oBAClB,MAAM,QAAQ,GAAe,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;oBAC1E,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBACrB,CAAC;gBACD,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/loader.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Astro content loader for MkDocs Material documentation.
+ *
+ * Reads .md files with MkDocs syntax (!!!, ???, ===, ++key++, etc.),
+ * parses with dogsbay-mkdocs, and produces TreeNode[] that
+ * ContentRenderer.astro can render through real components.
+ */
+import type MarkdownIt from "markdown-it";
+import type { TreeNode } from "@dogsbay/types";
+export interface Heading {
+    depth: number;
+    slug: string;
+    text: string;
+    /** Symbol kind for API reference TOC entries (class, meth, attr, func, module) */
+    kind?: string;
+}
+export interface MkdocsParseResult {
+    tree: TreeNode[];
+    headings: Heading[];
+}
+/**
+ * Parse a MkDocs markdown string into a TreeNode[] + headings.
+ * Adapts tree node shapes to match base-astro's ContentRenderer expectations.
+ *
+ * ContentRenderer handles: prose, heading, code, callout, details, tabs, tab,
+ * table, deflist, dt, dd, steps, step, substeps.
+ *
+ * It does NOT handle: paragraph, ordered-list, unordered-list, list-item,
+ * blockquote, html, annotation-list, hr. These must be collapsed into prose
+ * nodes with pre-rendered HTML.
+ */
+export declare function parseMkdocsMarkdown(source: string, md: MarkdownIt, options?: {
+    collapse?: boolean;
+    env?: Record<string, unknown>;
+    youtubeEmbed?: boolean;
+    diagrams?: boolean;
+    autodoc?: {
+        sourceRoot: string;
+        globalOptions?: Record<string, unknown>;
+    };
+}): Promise<MkdocsParseResult>;
+//# sourceMappingURL=loader.d.ts.map

package/dist/loader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader.d.ts","sourceRoot":"","sources":["../src/loader.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,KAAK,UAAU,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,EAAE,QAAQ,EAAc,MAAM,gBAAgB,CAAC;AAK3D,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,kFAAkF;IAClF,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,QAAQ,EAAE,CAAC;IACjB,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,mBAAmB,CACvC,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,UAAU,EACd,OAAO,CAAC,EAAE;IAAE,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,OAAO,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAA;CAAE,GACrL,OAAO,CAAC,iBAAiB,CAAC,CAuD5B"}