@godxjp/markdown 31.27.0 → 31.28.0

package/dist/codec/index.d.ts

@@ -10,7 +10,7 @@
  * and the kit's own:
  *   callout{kind,title} · details · detailsSummary · detailsContent · columns · column{width} ·
  *   embed{target} (block `![[x]]`) · wikilink{target,heading,label} · embedInline{target} ·
- *   rawBlock{source} · rawInline{source}
+ *   rawBlock{source} · rawInline{source} · frontmatter{source} (YAML, first block only)
  * Marks: bold · italic · strike · code · link{href,title}.
  */
 type Mark = {
@@ -43,6 +43,20 @@ declare const COLUMNS_MAX = 4;
 /** Markdown → document (plain JSON, ProseMirror/Tiptap shape). Pure: no DOM. */
 declare function parse(markdown: string): Doc;
 
+type OutlineEntry = {
+    depth: number;
+    text: string;
+    id: string;
+};
+/**
+ * The body's headings with the ids `<Markdown>` gives them — GitHub slugs, de-duplicated in
+ * document order, the renderer's default rule — for a table of contents (the kit's `Anchor`). Pure.
+ * A host that passes its own `headingId` resolver to `<Markdown>` must use that same resolver here.
+ */
+declare function outline(markdown: string): OutlineEntry[];
+/** The body's YAML front matter, verbatim (without the `---` fences), or null. Parse it with your YAML library. */
+declare function frontmatterOf(markdown: string): string | null;
+
 /** Document → canonical Markdown. Pure: no DOM. */
 declare function serialize(doc: Doc | DocNode): string;
 
@@ -54,4 +68,4 @@ declare const CODEC_ID = "kit-md@1";
 /** `serialize(parse(markdown))` — the canonical form of a body, exactly what the editor saves. */
 declare function normalize(markdown: string): string;
 
-export { CALLOUT_KINDS, CODEC_ID, COLUMNS_MAX, COLUMNS_MIN, type CalloutKind, type Doc, type DocNode, type Mark, normalize, parse, serialize };
+export { CALLOUT_KINDS, CODEC_ID, COLUMNS_MAX, COLUMNS_MIN, type CalloutKind, type Doc, type DocNode, type Mark, type OutlineEntry, frontmatterOf, normalize, outline, parse, serialize };

package/dist/codec/index.js

@@ -73,15 +73,17 @@ function readColumns(node, nested) {
 import { directive } from "micromark-extension-directive";
 import { gfm } from "micromark-extension-gfm";
 import { cjkFriendlyExtension } from "micromark-extension-cjk-friendly";
+import { frontmatter } from "micromark-extension-frontmatter";
+import { frontmatterFromMarkdown, frontmatterToMarkdown } from "mdast-util-frontmatter";
 import { directiveFromMarkdown } from "mdast-util-directive";
 import { gfmFromMarkdown, gfmToMarkdown } from "mdast-util-gfm";
 function micromarkExtensions() {
   const [container] = directive().flow[58];
   const containerOnly = { flow: { 58: container } };
-  return [gfm(), cjkFriendlyExtension(), containerOnly];
+  return [gfm(), cjkFriendlyExtension(), frontmatter(["yaml"]), containerOnly];
 }
 function fromMarkdownExtensions() {
-  return [gfmFromMarkdown(), directiveFromMarkdown()];
+  return [gfmFromMarkdown(), directiveFromMarkdown(), frontmatterFromMarkdown(["yaml"])];
 }
 var WIDE = /[\u1100-\u115F\u2E80-\u303E\u3041-\u33FF\u3400-\u4DBF\u4E00-\u9FFF\uA000-\uA4CF\uAC00-\uD7A3\uF900-\uFAFF\uFE30-\uFE4F\uFF00-\uFF60\uFFE0-\uFFE6\u{1F300}-\u{1F64F}\u{1F900}-\u{1F9FF}\u{20000}-\u{3FFFD}]/u;
 function displayWidth(value) {
@@ -92,6 +94,9 @@ function displayWidth(value) {
 function toMarkdownGfm() {
   return gfmToMarkdown({ stringLength: displayWidth });
 }
+function toMarkdownFrontmatter() {
+  return frontmatterToMarkdown(["yaml"]);
+}
 
 // src/codec/options.ts
 function containerDirective(node, _, state, info) {
@@ -130,6 +135,7 @@ function toMarkdownOptions() {
     resourceLink: false,
     extensions: [
       toMarkdownGfm(),
+      toMarkdownFrontmatter(),
       { handlers: { containerDirective } }
     ]
   };
@@ -345,6 +351,8 @@ function block(node, depth) {
     }
     case "containerDirective":
       return [directiveBlock(node, depth)];
+    case "yaml":
+      return [{ type: "frontmatter", attrs: { source: node.value } }];
     default:
       return [raw(node, false)];
   }
@@ -536,6 +544,8 @@ function block2(node) {
       return [{ type: "html", value: `![[${String(attrs.target)}]]` }];
     case "rawBlock":
       return [{ type: "html", value: String(attrs.source) }];
+    case "frontmatter":
+      return [{ type: "yaml", value: String(attrs.source) }];
     default:
       return [];
   }
@@ -560,6 +570,29 @@ function serialize(doc) {
   return decodeAttentionReferences(tidy);
 }
 
+// src/codec/outline.ts
+import GithubSlugger from "github-slugger";
+import { visit } from "unist-util-visit";
+function textOf(node) {
+  if (node.type === "text" || node.type === "inlineCode" || node.type === "html") return node.value;
+  if (node.type === "image" || node.type === "imageReference") return "";
+  if ("children" in node) return node.children.map(textOf).join("");
+  return "";
+}
+function outline(markdown) {
+  const slugger = new GithubSlugger();
+  const entries = [];
+  visit(parseMdast(markdown.replace(/\r\n?/g, "\n")), "heading", (node) => {
+    const text2 = textOf(node);
+    entries.push({ depth: node.depth, text: text2, id: slugger.slug(text2) });
+  });
+  return entries;
+}
+function frontmatterOf(markdown) {
+  const first = parseMdast(markdown.replace(/\r\n?/g, "\n")).children[0];
+  return first?.type === "yaml" ? first.value : null;
+}
+
 // src/codec/index.ts
 var CODEC_ID = "kit-md@1";
 function normalize(markdown) {
@@ -570,7 +603,9 @@ export {
   CODEC_ID,
   COLUMNS_MAX,
   COLUMNS_MIN,
+  frontmatterOf,
   normalize,
+  outline,
   parse,
   serialize
 };

package/dist/index.d.ts

@@ -133,6 +133,19 @@ type MarkdownProps = {
      * default — this package carries no i18n; a host passes its localized strings.
      */
     calloutTitles?: Partial<Record<CalloutKind, string>>;
+    /**
+     * Where an EXTERNAL link opens. An external link is an absolute http(s) URL whose origin differs
+     * from `origin`. `"new-tab"` gives it `target="_blank"` and `rel="noopener noreferrer"`. Relative
+     * links, `#anchors`, wikilinks resolved to a path, and `mailto:` stay in the tab. The default,
+     * `"same-tab"`, changes nothing. Markdown has no syntax for `target`, so this is a renderer policy.
+     */
+    externalLinks?: "same-tab" | "new-tab";
+    /**
+     * The page origin that `externalLinks` compares against. Defaults to `location.origin`. Pass it
+     * when rendering on the server, or every absolute link counts as external there and hydration
+     * disagrees on same-origin ones.
+     */
+    origin?: string;
 };
 /**
  * THE ONE RENDERER (gh#1108). GFM — tables, task lists, fenced code, autolinks, footnotes,
@@ -144,7 +157,7 @@ type MarkdownProps = {
  * Renders bare elements; the host wraps it (`<Prose>` from `@godxjp/ui/data-display`), so this
  * package carries no UI-kit dependency.
  */
-declare function Markdown({ children, remarkPlugins, rehypePlugins, schema, components, resolveUrl, headingId, mermaid, allowedElements, disallowedElements, allowElement, unwrapDisallowed, shortCellLength, calloutTitles, }: MarkdownProps): React.JSX.Element;
+declare function Markdown({ children, remarkPlugins, rehypePlugins, schema, components, resolveUrl, headingId, mermaid, allowedElements, disallowedElements, allowElement, unwrapDisallowed, shortCellLength, calloutTitles, externalLinks, origin, }: MarkdownProps): React.JSX.Element;
 
 type MermaidSvgCheck = {
     ok: true;

package/dist/index.js

@@ -339,15 +339,17 @@ function columnShares(columns) {
 import { directive } from "micromark-extension-directive";
 import { gfm } from "micromark-extension-gfm";
 import { cjkFriendlyExtension } from "micromark-extension-cjk-friendly";
+import { frontmatter } from "micromark-extension-frontmatter";
+import { frontmatterFromMarkdown, frontmatterToMarkdown } from "mdast-util-frontmatter";
 import { directiveFromMarkdown } from "mdast-util-directive";
 import { gfmFromMarkdown, gfmToMarkdown } from "mdast-util-gfm";
 function micromarkExtensions() {
   const [container] = directive().flow[58];
   const containerOnly = { flow: { 58: container } };
-  return [gfm(), cjkFriendlyExtension(), containerOnly];
+  return [gfm(), cjkFriendlyExtension(), frontmatter(["yaml"]), containerOnly];
 }
 function fromMarkdownExtensions() {
-  return [gfmFromMarkdown(), directiveFromMarkdown()];
+  return [gfmFromMarkdown(), directiveFromMarkdown(), frontmatterFromMarkdown(["yaml"])];
 }
 
 // src/directives.ts
@@ -367,7 +369,7 @@ function remarkKitSyntax(options = {}) {
   return function() {
     const data = this.data();
     (data.micromarkExtensions ??= []).push(...micromarkExtensions().slice(1));
-    (data.fromMarkdownExtensions ??= []).push(fromMarkdownExtensions()[1]);
+    (data.fromMarkdownExtensions ??= []).push(...fromMarkdownExtensions().slice(1));
     const walk = (node, inColumn) => {
       if (node.type === "blockquote") callout(node, titles);
       else if (node.type === "containerDirective") directive2(node, inColumn);
@@ -375,7 +377,10 @@ function remarkKitSyntax(options = {}) {
       const isColumn = node.type === "containerDirective" && node.name === "column";
       for (const child of node.children) walk(child, inColumn || isColumn);
     };
-    return (tree) => walk(tree, false);
+    return (tree) => {
+      tree.children = tree.children.filter((node) => node.type !== "yaml");
+      walk(tree, false);
+    };
   };
 }
 function callout(node, titles) {
@@ -470,6 +475,25 @@ function rehypeShortCells(options) {
     });
   };
 }
+function rehypeExternalLinks(options) {
+  return (tree) => {
+    if (options.policy !== "new-tab") return;
+    const origin = options.origin ?? globalThis.location?.origin;
+    visit2(tree, "element", (node) => {
+      if (node.tagName !== "a") return;
+      const href = node.properties?.href;
+      if (typeof href !== "string" || !/^https?:\/\//i.test(href)) return;
+      let target;
+      try {
+        target = new URL(href);
+      } catch {
+        return;
+      }
+      if (origin && target.origin === origin) return;
+      node.properties = { ...node.properties, target: "_blank", rel: ["noopener", "noreferrer"] };
+    });
+  };
+}
 function omitNode(props) {
   const { node: _node, ...rest } = props;
   return rest;
@@ -496,7 +520,9 @@ function Markdown({
   allowElement,
   unwrapDisallowed,
   shortCellLength = 24,
-  calloutTitles
+  calloutTitles,
+  externalLinks = "same-tab",
+  origin
 }) {
   const sanitizeSchema = React3.useMemo(() => extendSchema(schema), [schema]);
   const kitSyntax = React3.useMemo(() => remarkKitSyntax({ calloutTitles }), [calloutTitles]);
@@ -524,6 +550,7 @@ function Markdown({
         [rehypeHeadingIds, { resolve: headingId }],
         [rehypeSanitize, sanitizeSchema],
         [rehypeShortCells, { max: shortCellLength }],
+        [rehypeExternalLinks, { policy: externalLinks, origin }],
         ...rehypePlugins
       ],
       urlTransform: safeUrl,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@godxjp/markdown",
-  "version": "31.27.0",
+  "version": "31.28.0",
   "description": "The one Markdown renderer for GoDX apps: GFM + heading anchors, one sanitiser schema, a shared fixture corpus, and Mermaid drawn only after its SVG passes a fail-closed gate.",
   "type": "module",
   "main": "./dist/index.js",
@@ -36,10 +36,12 @@
     "github-slugger": "^2.0.0",
     "mdast-util-directive": "^3.1.1",
     "mdast-util-from-markdown": "^2.1.0",
+    "mdast-util-frontmatter": "^2.0.1",
     "mdast-util-gfm": "^3.1.0",
     "mdast-util-to-markdown": "^2.2.0",
     "micromark-extension-cjk-friendly": "^2.0.2",
     "micromark-extension-directive": "^4.0.0",
+    "micromark-extension-frontmatter": "^2.0.0",
     "micromark-extension-gfm": "^3.0.0",
     "micromark-util-types": "^2.0.2",
     "react-markdown": "^10.1.0",