@oud-idk/markdown 0.0.0-stage → 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+export * from "./components/CopyButton";
+export * from "./components/MarkdownLayout";
+export * from "./components/MarkdownRenderer";
+export * from "./components/MarkdownWithToC";
+export * from "./components/ScrollableMarkdownViewer";
+export * from "./components/TableOfContents";
+export * from "./components/useMarkdownScroller";
+export * from "./lib/markdown-plugins";
+export * from "./lib/markdown-toc";
+export * from "./lib/reading-time";
+export * from "./lib/linguist";
+//# 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,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,uCAAuC,CAAC;AACtD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,kCAAkC,CAAC;AACjD,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC"}

package/dist/index.js

@@ -0,0 +1,12 @@
+export * from "./components/CopyButton";
+export * from "./components/MarkdownLayout";
+export * from "./components/MarkdownRenderer";
+export * from "./components/MarkdownWithToC";
+export * from "./components/ScrollableMarkdownViewer";
+export * from "./components/TableOfContents";
+export * from "./components/useMarkdownScroller";
+export * from "./lib/markdown-plugins";
+export * from "./lib/markdown-toc";
+export * from "./lib/reading-time";
+export * from "./lib/linguist";
+//# 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,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,uCAAuC,CAAC;AACtD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,kCAAkC,CAAC;AACjD,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC"}

package/dist/lib/linguist.d.ts

@@ -0,0 +1,2 @@
+export declare function getLinguist(key: string): string | undefined;
+//# sourceMappingURL=linguist.d.ts.map

package/dist/lib/linguist.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"linguist.d.ts","sourceRoot":"","sources":["../../src/lib/linguist.ts"],"names":[],"mappings":"AASA,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAO3D"}

package/dist/lib/linguist.js

@@ -0,0 +1,14 @@
+import languageMap from '../data/language-map.json';
+// The JSON is inferred as an object literal with no index signature, so the
+// Record annotations are required to index it with a runtime string.
+const { names, extensions } = languageMap;
+export function getLinguist(key) {
+    const normalized = key.trim().toLowerCase();
+    if (normalized === "")
+        return undefined;
+    // `names` first: the key we hold from a ```rust fence is a language name or
+    // alias, not a file extension. `extensions` is the fallback for callers
+    // that have an actual file extension.
+    return names[normalized] ?? extensions[normalized];
+}
+//# sourceMappingURL=linguist.js.map

package/dist/lib/linguist.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"linguist.js","sourceRoot":"","sources":["../../src/lib/linguist.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,2BAA2B,CAAC;AAEpD,4EAA4E;AAC5E,qEAAqE;AACrE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAGvB,WAAW,CAAC;AAEhB,MAAM,UAAU,WAAW,CAAC,GAAW;IACnC,MAAM,UAAU,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAC5C,IAAI,UAAU,KAAK,EAAE;QAAE,OAAO,SAAS,CAAC;IACxC,4EAA4E;IAC5E,wEAAwE;IACxE,sCAAsC;IACtC,OAAO,KAAK,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC;AACvD,CAAC"}

package/dist/lib/markdown-plugins.d.ts

@@ -0,0 +1,4 @@
+import type { PluggableList } from "unified";
+export declare const remarkPlugins: PluggableList;
+export declare const rehypePlugins: PluggableList;
+//# sourceMappingURL=markdown-plugins.d.ts.map

package/dist/lib/markdown-plugins.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown-plugins.d.ts","sourceRoot":"","sources":["../../src/lib/markdown-plugins.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAmE7C,eAAO,MAAM,aAAa,EAAE,aAAwF,CAAC;AAErH,eAAO,MAAM,aAAa,EAAE,aAiB3B,CAAC"}

package/dist/lib/markdown-plugins.js

@@ -0,0 +1,75 @@
+import { visit } from "unist-util-visit";
+import remarkGfm from "remark-gfm";
+import remarkMath from "remark-math";
+import remarkBreaks from "remark-breaks";
+import remarkDirective from "remark-directive";
+/**
+ * Turns `:::sidebyside` container directives into a `<div class="sidebyside">`
+ * via mdast-util-to-hast's `data.hName`/`data.hProperties` passthrough.
+ */
+const remarkSideBySide = () => (tree) => {
+    visit(tree, (node) => {
+        if (node.type === "containerDirective" &&
+            node.name === "sidebyside") {
+            const n = node;
+            n.data = n.data ?? {};
+            n.data.hName = "div";
+            n.data.hProperties = { className: "sidebyside" };
+        }
+    });
+};
+import rehypeRaw from "rehype-raw";
+import rehypeKatex from "rehype-katex";
+import rehypeSlug from "rehype-slug";
+import rehypeAutolinkHeadings from "rehype-autolink-headings";
+import rehypeExternalLinks from "rehype-external-links";
+import rehypeShiki from "@shikijs/rehype";
+const languageTransformer = {
+    name: "language-badge",
+    pre(node) {
+        node.properties["data-language"] = this.options.lang;
+    },
+    code(node) {
+        node.properties["data-block"] = "";
+    },
+};
+/**
+ * react-markdown funnels *every* `code` element through our `code` component
+ * override, so the inline-code pill (background, border, padding, radius) also
+ * lands on the `code` nested inside a fenced block. The shiki transformer tags
+ * highlighted blocks with `data-block` to opt out, but a block with no language
+ * never reaches shiki and so is never tagged — it renders as a bordered pill
+ * sitting inside its own `<pre>`. Tag every `pre > code` here instead, running
+ * after shiki so highlighted output is covered too.
+ */
+const rehypeMarkBlockCode = () => (tree) => {
+    visit(tree, "element", (node) => {
+        if (node.tagName !== "pre")
+            return;
+        for (const child of node.children) {
+            if (child.type === "element" && child.tagName === "code") {
+                child.properties["data-block"] = "";
+            }
+        }
+    });
+};
+export const remarkPlugins = [remarkGfm, remarkMath, remarkBreaks, remarkDirective, remarkSideBySide];
+export const rehypePlugins = [
+    rehypeRaw,
+    rehypeKatex,
+    rehypeSlug,
+    [rehypeAutolinkHeadings],
+    [rehypeExternalLinks, { target: "_blank", rel: ["noopener", "noreferrer"] }],
+    [
+        rehypeShiki,
+        {
+            themes: {
+                light: "light-plus",
+                dark: "dark-plus",
+            },
+            transformers: [languageTransformer],
+        },
+    ],
+    rehypeMarkBlockCode,
+];
+//# sourceMappingURL=markdown-plugins.js.map

package/dist/lib/markdown-plugins.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown-plugins.js","sourceRoot":"","sources":["../../src/lib/markdown-plugins.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC,OAAO,SAAS,MAAM,YAAY,CAAC;AACnC,OAAO,UAAU,MAAM,aAAa,CAAC;AACrC,OAAO,YAAY,MAAM,eAAe,CAAC;AACzC,OAAO,eAAe,MAAM,kBAAkB,CAAC;AAG/C;;;GAGG;AACH,MAAM,gBAAgB,GAAG,GAAG,EAAE,CAAC,CAAC,IAAe,EAAE,EAAE;IAC/C,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE;QACjB,IACI,IAAI,CAAC,IAAI,KAAK,oBAAoB;YACjC,IAA0B,CAAC,IAAI,KAAK,YAAY,EACnD,CAAC;YACC,MAAM,CAAC,GAAG,IAAqD,CAAC;YAChE,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;YACtB,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;YACrB,CAAC,CAAC,IAAI,CAAC,WAAW,GAAG,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC;QACrD,CAAC;IACL,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,OAAO,SAAS,MAAM,YAAY,CAAC;AACnC,OAAO,WAAW,MAAM,cAAc,CAAC;AACvC,OAAO,UAAU,MAAM,aAAa,CAAC;AACrC,OAAO,sBAAsB,MAAM,0BAA0B,CAAC;AAC9D,OAAO,mBAAmB,MAAM,uBAAuB,CAAC;AACxD,OAAO,WAAW,MAAM,iBAAiB,CAAC;AAG1C,MAAM,mBAAmB,GAAqB;IAC1C,IAAI,EAAE,gBAAgB;IACtB,GAAG,CAAC,IAAI;QACJ,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IACzD,CAAC;IACD,IAAI,CAAC,IAAI;QACL,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC;IACvC,CAAC;CACJ,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,mBAAmB,GAAG,GAAG,EAAE,CAAC,CAAC,IAAU,EAAE,EAAE;IAC7C,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE;QAC5B,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK;YAAE,OAAO;QAEnC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAChC,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,KAAK,MAAM,EAAE,CAAC;gBACvD,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC;YACxC,CAAC;QACL,CAAC;IACL,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAkB,CAAC,SAAS,EAAE,UAAU,EAAE,YAAY,EAAE,eAAe,EAAE,gBAAgB,CAAC,CAAC;AAErH,MAAM,CAAC,MAAM,aAAa,GAAkB;IACxC,SAAS;IACT,WAAW;IACX,UAAU;IACV,CAAC,sBAAsB,CAAC;IACxB,CAAC,mBAAmB,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,UAAU,EAAE,YAAY,CAAC,EAAE,CAAC;IAC5E;QACI,WAAW;QACX;YACI,MAAM,EAAE;gBACJ,KAAK,EAAE,YAAY;gBACnB,IAAI,EAAE,WAAW;aACpB;YACD,YAAY,EAAE,CAAC,mBAAmB,CAAC;SACtC;KACJ;IACD,mBAAmB;CACtB,CAAC"}

package/dist/lib/markdown-toc.d.ts

@@ -0,0 +1,20 @@
+import type { Root } from "hast";
+export interface TocItem {
+    id: string;
+    text: string;
+    level: number;
+}
+interface CollectHeadingsOptions {
+    /** Array the outline is written to, in document order. */
+    into: TocItem[];
+}
+/**
+ * Collects the heading outline while the document is being rendered, so the
+ * ToC and the document come out of a single parse of the markdown.
+ *
+ * Server-side only: wire it in after `rehype-slug` (it reads the ids that
+ * plugin mints) via `[rehypeCollectHeadings, { into }]`.
+ */
+export declare function rehypeCollectHeadings({ into }: CollectHeadingsOptions): (tree: Root) => void;
+export {};
+//# sourceMappingURL=markdown-toc.d.ts.map

package/dist/lib/markdown-toc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown-toc.d.ts","sourceRoot":"","sources":["../../src/lib/markdown-toc.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAW,IAAI,EAAE,MAAM,MAAM,CAAC;AAE1C,MAAM,WAAW,OAAO;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACjB;AAKD,UAAU,sBAAsB;IAC5B,0DAA0D;IAC1D,IAAI,EAAE,OAAO,EAAE,CAAC;CACnB;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,EAAE,IAAI,EAAE,EAAE,sBAAsB,IAC1D,MAAM,IAAI,KAAG,IAAI,CAsB5B"}

package/dist/lib/markdown-toc.js

@@ -0,0 +1,34 @@
+import { visit } from "unist-util-visit";
+import { headingRank } from "hast-util-heading-rank";
+import { toString } from "hast-util-to-string";
+/** Deepest heading level the ToC lists; matches the old `h1, h2, h3, h4` query. */
+const MAX_LEVEL = 4;
+/**
+ * Collects the heading outline while the document is being rendered, so the
+ * ToC and the document come out of a single parse of the markdown.
+ *
+ * Server-side only: wire it in after `rehype-slug` (it reads the ids that
+ * plugin mints) via `[rehypeCollectHeadings, { into }]`.
+ */
+export function rehypeCollectHeadings({ into }) {
+    return (tree) => {
+        visit(tree, "element", (node) => {
+            const level = headingRank(node);
+            if (level == null || level > MAX_LEVEL) {
+                return;
+            }
+            // `rehype-slug` only fills in missing ids, so a heading written as
+            // raw HTML keeps its own — read it rather than re-slugging the text.
+            const id = node.properties.id;
+            if (typeof id !== "string" || id.trim() === "") {
+                return;
+            }
+            const text = toString(node);
+            if (text.trim() === "") {
+                return;
+            }
+            into.push({ id, text, level });
+        });
+    };
+}
+//# sourceMappingURL=markdown-toc.js.map

package/dist/lib/markdown-toc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown-toc.js","sourceRoot":"","sources":["../../src/lib/markdown-toc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAS/C,mFAAmF;AACnF,MAAM,SAAS,GAAG,CAAC,CAAC;AAOpB;;;;;;GAMG;AACH,MAAM,UAAU,qBAAqB,CAAC,EAAE,IAAI,EAA0B;IAClE,OAAO,CAAC,IAAU,EAAQ,EAAE;QACxB,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,IAAa,EAAE,EAAE;YACrC,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;YAChC,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,GAAG,SAAS,EAAE,CAAC;gBACrC,OAAO;YACX,CAAC;YAED,mEAAmE;YACnE,qEAAqE;YACrE,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YAC9B,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;gBAC7C,OAAO;YACX,CAAC;YAED,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC5B,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;gBACrB,OAAO;YACX,CAAC;YAED,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;AACN,CAAC"}

package/dist/lib/reading-time.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Reading time for a markdown document. Code fences and HTML comments are
+ * stripped first so a wall of SQL doesn't inflate the estimate.
+ */
+export declare function readingTime(markdown: string): {
+    words: number;
+    minutes: number;
+};
+//# sourceMappingURL=reading-time.d.ts.map

package/dist/lib/reading-time.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reading-time.d.ts","sourceRoot":"","sources":["../../src/lib/reading-time.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAShF"}

package/dist/lib/reading-time.js

@@ -0,0 +1,14 @@
+const WORDS_PER_MINUTE = 225;
+/**
+ * Reading time for a markdown document. Code fences and HTML comments are
+ * stripped first so a wall of SQL doesn't inflate the estimate.
+ */
+export function readingTime(markdown) {
+    const cleaned = markdown
+        .replace(/<!--[\s\S]*?-->/g, "")
+        .replace(/```[\s\S]*?```/g, "")
+        .trim();
+    const words = cleaned.split(/\s+/).filter(Boolean).length;
+    return { words, minutes: Math.max(1, Math.ceil(words / WORDS_PER_MINUTE)) };
+}
+//# sourceMappingURL=reading-time.js.map

package/dist/lib/reading-time.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reading-time.js","sourceRoot":"","sources":["../../src/lib/reading-time.ts"],"names":[],"mappings":"AAAA,MAAM,gBAAgB,GAAG,GAAG,CAAC;AAE7B;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,QAAgB;IACxC,MAAM,OAAO,GAAG,QAAQ;SACnB,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC;SAC/B,OAAO,CAAC,iBAAiB,EAAE,EAAE,CAAC;SAC9B,IAAI,EAAE,CAAC;IAEZ,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC;IAE1D,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,gBAAgB,CAAC,CAAC,EAAE,CAAC;AAChF,CAAC"}

package/package.json

@@ -1,6 +1,61 @@
 {
   "name": "@oud-idk/markdown",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "description": "Markdown rendering system: React components, remark/rehype plugins, table of contents, reading time.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": [
+    "*.css"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0"
+  },
+  "dependencies": {
+    "@shikijs/rehype": "^4.5.0",
+    "cn": "^0.4.0",
+    "hast-util-heading-rank": "^3.0.0",
+    "hast-util-to-string": "^3.0.1",
+    "katex": "^0.17.0",
+    "lucide-react": "^1.49.0",
+    "react-markdown": "^10.1.0",
+    "rehype-autolink-headings": "^7.1.0",
+    "rehype-external-links": "^3.0.0",
+    "rehype-katex": "^7.0.1",
+    "rehype-raw": "^7.0.0",
+    "rehype-slug": "^6.0.0",
+    "remark-breaks": "^4.0.0",
+    "remark-directive": "^4.0.0",
+    "remark-gfm": "^4.0.1",
+    "remark-math": "^6.0.0",
+    "shiki": "^4.5.0",
+    "tw-animate-css": "^1.4.0",
+    "unified": "^11.0.5",
+    "unist-util-visit": "^5.1.0"
+  },
+  "devDependencies": {
+    "@types/mdast": "^4.0.4",
+    "@types/hast": "^3.0.5",
+    "@types/react": "^19",
+    "@types/react-dom": "^19",
+    "typescript": "^5"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "clean": "rm -rf dist",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  }
 }