@readme/markdown 13.6.1 → 13.6.3

package/dist/lib/ast-processor.d.ts

@@ -7,10 +7,10 @@ export interface MdastOpts {
     missingComponents?: 'ignore' | 'throw';
     remarkPlugins?: PluggableList;
 }
-export declare const remarkPlugins: (typeof remarkGfm | (() => (tree: import("mdast").Root) => void) | (({ copyButtons }?: {
-    copyButtons?: boolean;
-}) => (tree: import("mdast").Node) => import("mdast").Node) | (({ isMdxish }?: {
+export declare const remarkPlugins: (typeof remarkGfm | (({ isMdxish }?: {
     isMdxish?: boolean;
+}) => (tree: import("mdast").Root) => void) | (({ copyButtons }?: {
+    copyButtons?: boolean;
 }) => (tree: import("mdast").Node) => import("mdast").Node) | typeof remarkFrontmatter)[];
 export declare const rehypePlugins: (typeof rehypeSlug | (() => (tree: import("unist").Node) => import("unist").Node))[];
 declare const astProcessor: (opts?: MdastOpts) => import("unified").Processor<import("mdast").Root, import("mdast").Root, import("mdast").Root, import("mdast").Root, string>;

package/dist/lib/plain.d.ts

@@ -9,6 +9,13 @@ interface Options {
      * their respective regexes.
      */
     preserveVariableSyntax?: boolean;
+    /**
+     * Separator to use when joining sibling nodes.
+     * Defaults to a space for document-level plain text extraction.
+     * Use an empty string for inline-only contexts like TOC labels, where
+     * adjacent inline siblings should preserve authored adjacency.
+     */
+    separator?: string;
     variables?: Record<string, string>;
 }
 declare const plain: (node: Nodes, opts?: Options) => string | number | true | (string | number)[];

package/dist/main.js

@@ -32830,13 +32830,9 @@ function listItemWithTaskListItem(node, parent, state, info) {
 
 ;// ./node_modules/mdast-util-gfm/lib/index.js
 /**
- * @typedef {import('mdast-util-from-markdown').Extension} FromMarkdownExtension
- * @typedef {import('mdast-util-to-markdown').Options} ToMarkdownExtension
- */
-
-/**
- * @typedef {import('mdast-util-gfm-table').Options} Options
- *   Configuration.
+ * @import {Extension as FromMarkdownExtension} from 'mdast-util-from-markdown'
+ * @import {Options} from 'mdast-util-gfm'
+ * @import {Options as ToMarkdownExtension} from 'mdast-util-to-markdown'
  */
 
 
@@ -32868,7 +32864,7 @@ function gfmFromMarkdown() {
  * literals, footnotes, strikethrough, tables, tasklists).
  *
  * @param {Options | null | undefined} [options]
- *   Configuration.
+ *   Configuration (optional).
  * @returns {ToMarkdownExtension}
  *   Extension for `mdast-util-to-markdown` to enable GFM (autolink literals,
  *   footnotes, strikethrough, tables, tasklists).
@@ -32877,7 +32873,7 @@ function gfmToMarkdown(options) {
   return {
     extensions: [
       gfmAutolinkLiteralToMarkdown(),
-      gfmFootnoteToMarkdown(),
+      gfmFootnoteToMarkdown(options),
       gfmStrikethroughToMarkdown(),
       gfmTableToMarkdown(options),
       gfmTaskListItemToMarkdown()
@@ -53015,11 +53011,12 @@ function plain_one(node, opts) {
 function plain_all(node, opts) {
     let index = -1;
     const result = [];
+    const separator = opts.separator ?? ' ';
     // eslint-disable-next-line no-plusplus
     while (++index < node?.children.length) {
         result[index] = plain_one(node.children[index], opts);
     }
-    return result.join(' ').replaceAll(/\s+/g, ' ').trim();
+    return result.join(separator).replaceAll(/\s+/g, ' ').trim();
 }
 const plain = (node, opts = {}) => {
     return 'children' in node ? plain_all(node, opts) || plain_one(node, opts) : plain_one(node, opts);
@@ -53080,7 +53077,7 @@ const titleParser = unified().use(remarkParse).use(remarkGfm);
 // The title paragraph may contain custom AST nodes that `toMarkdown` doesn't
 // natively understand
 const toMarkdownExtensions = [
-    gfmStrikethroughToMarkdown(),
+    gfmToMarkdown(),
     // For mdx variable syntaxes (e.g., {user.name})
     mdxExpressionToMarkdown(),
     // Important: This is required and would crash the parser if there's no variable node handler
@@ -53172,7 +53169,7 @@ const removeIconPrefix = (paragraph, prefixLength) => {
         firstTextNode.value = firstTextNode.value.slice(prefixLength);
     }
 };
-const processBlockquote = (node, index, parent) => {
+const processBlockquote = (node, index, parent, isMdxish = false) => {
     if (!isCalloutStructure(node)) {
         // Only stringify empty blockquotes (no extractable text content)
         // Preserve blockquotes with actual content (e.g., headings, lists, etc.)
@@ -53220,7 +53217,11 @@ const processBlockquote = (node, index, parent) => {
                 node.children[0].position.start.offset += match.length;
                 node.children[0].position.start.column += match.length;
             }
-            else {
+            else if (isMdxish) {
+                // Block-level title re-parsing is only needed for MDXish where HTML stays
+                // as raw nodes. In MDX, remarkMdx has already converted HTML to JSX AST
+                // nodes which toMarkdown can't serialize — and MDX doesn't need this
+                // block-level title handling anyway.
                 const headingText = toMarkdown({ type: 'root', children: [firstParagraph] }, {
                     extensions: toMarkdownExtensions,
                 })
@@ -53246,6 +53247,11 @@ const processBlockquote = (node, index, parent) => {
                     node.children[0].position.start.column += match.length;
                 }
             }
+            else {
+                node.children[0] = wrapHeading(node);
+                node.children[0].position.start.offset += match.length;
+                node.children[0].position.start.column += match.length;
+            }
         }
         // Insert body content as a separate paragraph after the heading
         if (bodyChildren) {
@@ -53276,10 +53282,10 @@ const processBlockquote = (node, index, parent) => {
         });
     }
 };
-const calloutTransformer = () => {
+const calloutTransformer = ({ isMdxish = false } = {}) => {
     const processNode = (root) => {
         visit(root, 'blockquote', (node, index, parent) => {
-            processBlockquote(node, index, parent);
+            processBlockquote(node, index, parent, isMdxish);
             if (node.type === NodeTypes.callout) {
                 // SKIP prevents re-processing synthetic blockquotes in parsed title content
                 // (e.g., blockquotes from "> Quote" titles). Recursively process body children
@@ -71261,6 +71267,7 @@ const normalizeEmphasisAST = () => (tree) => {
 
 
 
+
 const isTableCell = (node) => isMDXElement(node) && ['th', 'td'].includes(node.name);
 const tableTypes = {
     tr: 'tableRow',
@@ -71271,7 +71278,7 @@ const tableNodeProcessor = unified()
     .use(remarkParse)
     .use(remarkMdx)
     .use(normalize_malformed_md_syntax)
-    .use([callouts, gemoji_])
+    .use([[callouts, { isMdxish: true }], gemoji_, code_tabs])
     .use(remarkGfm);
 /**
  * Check if children are only text nodes that might contain markdown
@@ -72140,7 +72147,12 @@ const defaultTransforms = {
     imageTransformer: transform_images,
     gemojiTransformer: gemoji_,
 };
-const mdxishTransformers = [callouts, code_tabs, transform_images, gemoji_];
+const mdxishTransformers = [
+    [callouts, { isMdxish: true }],
+    code_tabs,
+    transform_images,
+    gemoji_,
+];
 /* harmony default export */ const transform = (Object.values(defaultTransforms));
 
 ;// ./lib/ast-processor.ts
@@ -86943,7 +86955,7 @@ const tocToHast = (headings = [], variables) => {
             stack.pop();
         }
         if (heading.properties) {
-            const content = lib_plain({ type: 'root', children: heading.children }, { variables: flatVars });
+            const content = lib_plain({ type: 'root', children: heading.children }, { separator: '', variables: flatVars });
             stack[stack.length - 1].children.push(hastscript_lib_h('li', null, hastscript_lib_h('a', { href: `#${heading.properties.id}` }, content)));
         }
     });
@@ -93754,6 +93766,14 @@ const rehypeMdxishComponents = ({ components, processMarkdown }) => {
         visit(tree, 'element', (node, index, parent) => {
             if (index === undefined || !parent)
                 return;
+            // Parse Image caption as markdown so it renders formatted (bold, code,
+            // decoded entities) in the figcaption instead of as a raw string.
+            // rehypeRaw strips children from <img> (void element), so we must
+            // re-process the caption here, after rehypeRaw.
+            if (node.tagName === 'img' && typeof node.properties?.caption === 'string' && !node.children?.length) {
+                const captionHast = processMarkdown(node.properties.caption);
+                node.children = (captionHast.children ?? []).filter(isElementContentNode);
+            }
             // Skip runtime components and standard HTML tags
             if (RUNTIME_COMPONENT_TAGS.has(node.tagName))
                 return;
@@ -95816,6 +95836,21 @@ const stripClosingTagFromParagraph = (node, tag) => {
     if (closingIndex === -1)
         return { paragraph: node, found: false };
     children.splice(closingIndex, 1);
+    // After removing the closing tag, trim trailing whitespace/newlines from the
+    // preceding text node. Remark parses "Hello\n</Callout>" as text("Hello\n") +
+    // html("</Callout>"), and the leftover \n would be converted to <br> in HAST.
+    if (closingIndex > 0) {
+        const prev = children[closingIndex - 1];
+        if (prev.type === 'text') {
+            const trimmed = prev.value.trimEnd();
+            if (trimmed) {
+                prev.value = trimmed;
+            }
+            else {
+                children.splice(closingIndex - 1, 1);
+            }
+        }
+    }
     return { paragraph: { ...node, children }, found: true };
 };
 /**
@@ -96428,6 +96463,7 @@ const mdxishInlineComponents = () => tree => {
 
 
 
+
 const transformAnchor = (jsx) => {
     const attrs = getAttrs(jsx);
     const { href = '', label, target, title } = attrs;
@@ -96467,6 +96503,7 @@ const transformImage = (jsx) => {
         alt,
         border: border !== undefined ? String(border) : undefined,
         caption,
+        children: caption ? lib_mdast(caption).children : [],
         className,
         height: height !== undefined ? String(height) : undefined,
         lazy,
@@ -98947,7 +98984,12 @@ function loadComponents() {
 
 
 
-const defaultTransformers = [callouts, code_tabs, gemoji_, transform_embeds];
+const defaultTransformers = [
+    [callouts, { isMdxish: true }],
+    code_tabs,
+    gemoji_,
+    transform_embeds,
+];
 /**
  * Preprocessing pipeline: applies string-level transformations to work around
  * CommonMark/remark limitations and reach parity with legacy (rdmd) rendering.
@@ -98994,8 +99036,21 @@ function mdxishAstProcessor(mdContent, opts = {}) {
         ? [jsxTable(), magicBlock(), legacyVariable(), looseHtmlEntity()]
         : [jsxTable(), magicBlock(), mdxExprTextOnly, legacyVariable(), looseHtmlEntity()])
         .data('fromMarkdownExtensions', safeMode
-        ? [jsxTableFromMarkdown(), magicBlockFromMarkdown(), legacyVariableFromMarkdown(), emptyTaskListItemFromMarkdown(), looseHtmlEntityFromMarkdown()]
-        : [jsxTableFromMarkdown(), magicBlockFromMarkdown(), mdxExpressionFromMarkdown(), legacyVariableFromMarkdown(), emptyTaskListItemFromMarkdown(), looseHtmlEntityFromMarkdown()])
+        ? [
+            jsxTableFromMarkdown(),
+            magicBlockFromMarkdown(),
+            legacyVariableFromMarkdown(),
+            emptyTaskListItemFromMarkdown(),
+            looseHtmlEntityFromMarkdown(),
+        ]
+        : [
+            jsxTableFromMarkdown(),
+            magicBlockFromMarkdown(),
+            mdxExpressionFromMarkdown(),
+            legacyVariableFromMarkdown(),
+            emptyTaskListItemFromMarkdown(),
+            looseHtmlEntityFromMarkdown(),
+        ])
         .use(remarkParse)
         .use(remarkFrontmatter)
         .use(normalize_malformed_md_syntax)

package/dist/main.node.js

@@ -46998,13 +46998,9 @@ function listItemWithTaskListItem(node, parent, state, info) {
 
 ;// ./node_modules/mdast-util-gfm/lib/index.js
 /**
- * @typedef {import('mdast-util-from-markdown').Extension} FromMarkdownExtension
- * @typedef {import('mdast-util-to-markdown').Options} ToMarkdownExtension
- */
-
-/**
- * @typedef {import('mdast-util-gfm-table').Options} Options
- *   Configuration.
+ * @import {Extension as FromMarkdownExtension} from 'mdast-util-from-markdown'
+ * @import {Options} from 'mdast-util-gfm'
+ * @import {Options as ToMarkdownExtension} from 'mdast-util-to-markdown'
  */
 
 
@@ -47036,7 +47032,7 @@ function gfmFromMarkdown() {
  * literals, footnotes, strikethrough, tables, tasklists).
  *
  * @param {Options | null | undefined} [options]
- *   Configuration.
+ *   Configuration (optional).
  * @returns {ToMarkdownExtension}
  *   Extension for `mdast-util-to-markdown` to enable GFM (autolink literals,
  *   footnotes, strikethrough, tables, tasklists).
@@ -47045,7 +47041,7 @@ function gfmToMarkdown(options) {
   return {
     extensions: [
       gfmAutolinkLiteralToMarkdown(),
-      gfmFootnoteToMarkdown(),
+      gfmFootnoteToMarkdown(options),
       gfmStrikethroughToMarkdown(),
       gfmTableToMarkdown(options),
       gfmTaskListItemToMarkdown()
@@ -73219,11 +73215,12 @@ function plain_one(node, opts) {
 function plain_all(node, opts) {
     let index = -1;
     const result = [];
+    const separator = opts.separator ?? ' ';
     // eslint-disable-next-line no-plusplus
     while (++index < node?.children.length) {
         result[index] = plain_one(node.children[index], opts);
     }
-    return result.join(' ').replaceAll(/\s+/g, ' ').trim();
+    return result.join(separator).replaceAll(/\s+/g, ' ').trim();
 }
 const plain = (node, opts = {}) => {
     return 'children' in node ? plain_all(node, opts) || plain_one(node, opts) : plain_one(node, opts);
@@ -73284,7 +73281,7 @@ const titleParser = unified().use(remarkParse).use(remarkGfm);
 // The title paragraph may contain custom AST nodes that `toMarkdown` doesn't
 // natively understand
 const toMarkdownExtensions = [
-    gfmStrikethroughToMarkdown(),
+    gfmToMarkdown(),
     // For mdx variable syntaxes (e.g., {user.name})
     mdxExpressionToMarkdown(),
     // Important: This is required and would crash the parser if there's no variable node handler
@@ -73376,7 +73373,7 @@ const removeIconPrefix = (paragraph, prefixLength) => {
         firstTextNode.value = firstTextNode.value.slice(prefixLength);
     }
 };
-const processBlockquote = (node, index, parent) => {
+const processBlockquote = (node, index, parent, isMdxish = false) => {
     if (!isCalloutStructure(node)) {
         // Only stringify empty blockquotes (no extractable text content)
         // Preserve blockquotes with actual content (e.g., headings, lists, etc.)
@@ -73424,7 +73421,11 @@ const processBlockquote = (node, index, parent) => {
                 node.children[0].position.start.offset += match.length;
                 node.children[0].position.start.column += match.length;
             }
-            else {
+            else if (isMdxish) {
+                // Block-level title re-parsing is only needed for MDXish where HTML stays
+                // as raw nodes. In MDX, remarkMdx has already converted HTML to JSX AST
+                // nodes which toMarkdown can't serialize — and MDX doesn't need this
+                // block-level title handling anyway.
                 const headingText = toMarkdown({ type: 'root', children: [firstParagraph] }, {
                     extensions: toMarkdownExtensions,
                 })
@@ -73450,6 +73451,11 @@ const processBlockquote = (node, index, parent) => {
                     node.children[0].position.start.column += match.length;
                 }
             }
+            else {
+                node.children[0] = wrapHeading(node);
+                node.children[0].position.start.offset += match.length;
+                node.children[0].position.start.column += match.length;
+            }
         }
         // Insert body content as a separate paragraph after the heading
         if (bodyChildren) {
@@ -73480,10 +73486,10 @@ const processBlockquote = (node, index, parent) => {
         });
     }
 };
-const calloutTransformer = () => {
+const calloutTransformer = ({ isMdxish = false } = {}) => {
     const processNode = (root) => {
         visit(root, 'blockquote', (node, index, parent) => {
-            processBlockquote(node, index, parent);
+            processBlockquote(node, index, parent, isMdxish);
             if (node.type === NodeTypes.callout) {
                 // SKIP prevents re-processing synthetic blockquotes in parsed title content
                 // (e.g., blockquotes from "> Quote" titles). Recursively process body children
@@ -91465,6 +91471,7 @@ const normalizeEmphasisAST = () => (tree) => {
 
 
 
+
 const isTableCell = (node) => isMDXElement(node) && ['th', 'td'].includes(node.name);
 const tableTypes = {
     tr: 'tableRow',
@@ -91475,7 +91482,7 @@ const tableNodeProcessor = unified()
     .use(remarkParse)
     .use(remarkMdx)
     .use(normalize_malformed_md_syntax)
-    .use([callouts, gemoji_])
+    .use([[callouts, { isMdxish: true }], gemoji_, code_tabs])
     .use(remarkGfm);
 /**
  * Check if children are only text nodes that might contain markdown
@@ -92344,7 +92351,12 @@ const defaultTransforms = {
     imageTransformer: transform_images,
     gemojiTransformer: gemoji_,
 };
-const mdxishTransformers = [callouts, code_tabs, transform_images, gemoji_];
+const mdxishTransformers = [
+    [callouts, { isMdxish: true }],
+    code_tabs,
+    transform_images,
+    gemoji_,
+];
 /* harmony default export */ const transform = (Object.values(defaultTransforms));
 
 ;// ./lib/ast-processor.ts
@@ -107147,7 +107159,7 @@ const tocToHast = (headings = [], variables) => {
             stack.pop();
         }
         if (heading.properties) {
-            const content = lib_plain({ type: 'root', children: heading.children }, { variables: flatVars });
+            const content = lib_plain({ type: 'root', children: heading.children }, { separator: '', variables: flatVars });
             stack[stack.length - 1].children.push(hastscript_lib_h('li', null, hastscript_lib_h('a', { href: `#${heading.properties.id}` }, content)));
         }
     });
@@ -113958,6 +113970,14 @@ const rehypeMdxishComponents = ({ components, processMarkdown }) => {
         visit(tree, 'element', (node, index, parent) => {
             if (index === undefined || !parent)
                 return;
+            // Parse Image caption as markdown so it renders formatted (bold, code,
+            // decoded entities) in the figcaption instead of as a raw string.
+            // rehypeRaw strips children from <img> (void element), so we must
+            // re-process the caption here, after rehypeRaw.
+            if (node.tagName === 'img' && typeof node.properties?.caption === 'string' && !node.children?.length) {
+                const captionHast = processMarkdown(node.properties.caption);
+                node.children = (captionHast.children ?? []).filter(isElementContentNode);
+            }
             // Skip runtime components and standard HTML tags
             if (RUNTIME_COMPONENT_TAGS.has(node.tagName))
                 return;
@@ -116020,6 +116040,21 @@ const stripClosingTagFromParagraph = (node, tag) => {
     if (closingIndex === -1)
         return { paragraph: node, found: false };
     children.splice(closingIndex, 1);
+    // After removing the closing tag, trim trailing whitespace/newlines from the
+    // preceding text node. Remark parses "Hello\n</Callout>" as text("Hello\n") +
+    // html("</Callout>"), and the leftover \n would be converted to <br> in HAST.
+    if (closingIndex > 0) {
+        const prev = children[closingIndex - 1];
+        if (prev.type === 'text') {
+            const trimmed = prev.value.trimEnd();
+            if (trimmed) {
+                prev.value = trimmed;
+            }
+            else {
+                children.splice(closingIndex - 1, 1);
+            }
+        }
+    }
     return { paragraph: { ...node, children }, found: true };
 };
 /**
@@ -116632,6 +116667,7 @@ const mdxishInlineComponents = () => tree => {
 
 
 
+
 const transformAnchor = (jsx) => {
     const attrs = getAttrs(jsx);
     const { href = '', label, target, title } = attrs;
@@ -116671,6 +116707,7 @@ const transformImage = (jsx) => {
         alt,
         border: border !== undefined ? String(border) : undefined,
         caption,
+        children: caption ? lib_mdast(caption).children : [],
         className,
         height: height !== undefined ? String(height) : undefined,
         lazy,
@@ -119151,7 +119188,12 @@ function loadComponents() {
 
 
 
-const defaultTransformers = [callouts, code_tabs, gemoji_, transform_embeds];
+const defaultTransformers = [
+    [callouts, { isMdxish: true }],
+    code_tabs,
+    gemoji_,
+    transform_embeds,
+];
 /**
  * Preprocessing pipeline: applies string-level transformations to work around
  * CommonMark/remark limitations and reach parity with legacy (rdmd) rendering.
@@ -119198,8 +119240,21 @@ function mdxishAstProcessor(mdContent, opts = {}) {
         ? [jsxTable(), magicBlock(), legacyVariable(), looseHtmlEntity()]
         : [jsxTable(), magicBlock(), mdxExprTextOnly, legacyVariable(), looseHtmlEntity()])
         .data('fromMarkdownExtensions', safeMode
-        ? [jsxTableFromMarkdown(), magicBlockFromMarkdown(), legacyVariableFromMarkdown(), emptyTaskListItemFromMarkdown(), looseHtmlEntityFromMarkdown()]
-        : [jsxTableFromMarkdown(), magicBlockFromMarkdown(), mdxExpressionFromMarkdown(), legacyVariableFromMarkdown(), emptyTaskListItemFromMarkdown(), looseHtmlEntityFromMarkdown()])
+        ? [
+            jsxTableFromMarkdown(),
+            magicBlockFromMarkdown(),
+            legacyVariableFromMarkdown(),
+            emptyTaskListItemFromMarkdown(),
+            looseHtmlEntityFromMarkdown(),
+        ]
+        : [
+            jsxTableFromMarkdown(),
+            magicBlockFromMarkdown(),
+            mdxExpressionFromMarkdown(),
+            legacyVariableFromMarkdown(),
+            emptyTaskListItemFromMarkdown(),
+            looseHtmlEntityFromMarkdown(),
+        ])
         .use(remarkParse)
         .use(remarkFrontmatter)
         .use(normalize_malformed_md_syntax)