@readme/markdown 15.9.3 → 15.10.0

package/dist/index.d.ts

@@ -6,7 +6,7 @@ declare const utils: {
     getHref: typeof getHref;
     calloutIcons: {};
 };
-export { compile, exports, FLOW_TYPES, hast, htmlToMarkdown, INLINE_ONLY_PARENT_TYPES, run, mdast, mdastV6, mdx, mdxish, mdxishAstProcessor, mdxishMdastToMd, mdxishTags, extractToc, migrate, mix, plain, renderMdxish, remarkPlugins, stripComments, tags, } from './lib';
+export { compile, exports, FLOW_TYPES, hast, htmlToMarkdown, INLINE_ONLY_PARENT_TYPES, run, mdast, mdastV6, mdx, mdxish, mdxishAstProcessor, mdxishHeadingIds, mdxishMdastToMd, mdxishTags, extractToc, migrate, mix, plain, renderMdxish, remarkPlugins, stripComments, tags, } from './lib';
 export type { ListMarker, ListWithMarker, MdxishOpts, RenderMdxishOpts, RunOpts } from './lib';
 export { default as Owlmoji } from './lib/owlmoji';
 export { Components, utils };

package/dist/lib/index.d.ts

@@ -10,6 +10,7 @@ export { default as mdastV6 } from './mdastV6';
 export { default as mdx } from './mdx';
 export { default as mix } from './mix';
 export { default as mdxish, mdxishAstProcessor, mdxishMdastToMd } from './mdxish';
+export { mdxishHeadingIds } from './mdxishHeadingIds';
 export type { ListMarker, ListWithMarker } from '../processor/compile/list';
 export type { MdxishOpts } from './mdxish';
 export { default as extractToc } from './extractToc';

package/dist/lib/mdast-util/heading-id/index.d.ts

@@ -0,0 +1,3 @@
+import type { Extension as FromMarkdownExtension } from 'mdast-util-from-markdown';
+/** Sets a heading's id from its `headingId` token. */
+export declare function headingIdFromMarkdown(): FromMarkdownExtension;

package/dist/lib/mdast-util/mdx-expression/index.d.ts

@@ -0,0 +1,3 @@
+import type { Extension as FromMarkdownExtension } from 'mdast-util-from-markdown';
+/** Upstream `mdxExpressionFromMarkdown`, overriding only the text-expression exit to keep `{...}` source in image alt. */
+export declare function mdxishExpressionFromMarkdown(): FromMarkdownExtension;

package/dist/lib/mdxish.d.ts

@@ -46,6 +46,8 @@ export declare function mdxishAstProcessor(mdContent: string, opts?: MdxishOpts)
  * Serializes an Mdast back into a markdown string.
  */
 export declare function mdxishMdastToMd(mdast: MdastRoot): string;
+/** The steps `mdxish()` runs after parsing; run it on the parse's VFile, since steps read `file.data`. */
+export declare function mdxishRenderProcessor(opts?: MdxishOpts): import("unified").Processor<undefined, MdastRoot, Root, undefined, undefined>;
 /**
  * Processes markdown content with MDX syntax support and returns a HAST.
  * Detects and renders custom component tags from the components hash.

package/dist/lib/mdxishHeadingIds.d.ts

@@ -0,0 +1,4 @@
+import type { MdxishOpts } from './mdxish';
+import type { Heading, Root as MdastRoot } from 'mdast';
+/** Each heading's rendered anchor id, worked out without running code; `null` when code could change them. */
+export declare function mdxishHeadingIds(tree: MdastRoot, opts?: Omit<MdxishOpts, 'safeMode'>): Map<Heading, string> | null;

package/dist/lib/micromark/heading-id/index.d.ts

@@ -0,0 +1 @@
+export { headingId } from './syntax';

package/dist/lib/micromark/heading-id/syntax.d.ts

@@ -0,0 +1,10 @@
+import type { Extension } from 'micromark-util-types';
+declare module 'micromark-util-types' {
+    interface TokenTypeMap {
+        headingId: 'headingId';
+    }
+}
+/** One character a `{#id}` heading id may use: the ones github-slugger keeps, plus `.` and `:`. */
+export declare const HEADING_ID_CHAR = "[\\p{L}\\p{M}\\p{N}_.:-]";
+/** The ATX heading construct, with a line-final ` {#id}` split off as a `headingId` token. */
+export declare function headingId(): Extension;

package/dist/lib/micromark/mdxish-extensions.d.ts

@@ -1,15 +1,17 @@
 import type { Extension as FromMarkdownExtension } from 'mdast-util-from-markdown';
 import type { Extension } from 'micromark-util-types';
-import { mdxExpressionFromMarkdown } from 'mdast-util-mdx-expression';
 import { mdxjsEsmFromMarkdown } from 'mdast-util-mdxjs-esm';
 import { emptyTaskListItemFromMarkdown } from '../mdast-util/empty-task-list-item';
 import { gemojiFromMarkdown } from '../mdast-util/gemoji';
+import { headingIdFromMarkdown } from '../mdast-util/heading-id';
 import { htmlBlockComponentFromMarkdown } from '../mdast-util/html-block-component';
 import { jsxTableFromMarkdown } from '../mdast-util/jsx-table';
 import { legacyVariableFromMarkdown } from '../mdast-util/legacy-variable';
 import { magicBlockFromMarkdown } from '../mdast-util/magic-block';
 import { mdxComponentFromMarkdown } from '../mdast-util/mdx-component';
+import { mdxishExpressionFromMarkdown } from '../mdast-util/mdx-expression';
 import { gemoji } from './gemoji';
+import { headingId } from './heading-id';
 import { htmlBlockComponent } from './html-block-component';
 import { jsxComment } from './jsx-comment';
 import { jsxTable } from './jsx-table';
@@ -50,12 +52,12 @@ declare const REGISTRY: {
     };
     mdxExpressionLenient: {
         syntax: typeof mdxExpressionLenient;
-        fromMarkdown: typeof mdxExpressionFromMarkdown;
+        fromMarkdown: typeof mdxishExpressionFromMarkdown;
         expression: true;
     };
     mdxExpression: {
         syntax: () => Extension;
-        fromMarkdown: typeof mdxExpressionFromMarkdown;
+        fromMarkdown: typeof mdxishExpressionFromMarkdown;
         expression: true;
     };
     mdxComponent: {
@@ -70,6 +72,10 @@ declare const REGISTRY: {
         syntax: typeof legacyVariable;
         fromMarkdown: typeof legacyVariableFromMarkdown;
     };
+    headingId: {
+        syntax: typeof headingId;
+        fromMarkdown: typeof headingIdFromMarkdown;
+    };
     looseHtmlEntity: {
         syntax: typeof looseHtmlEntity;
         fromMarkdown: typeof looseHtmlEntityFromMarkdown;
@@ -95,32 +101,32 @@ export type MdxishFeature = keyof typeof REGISTRY;
  */
 export declare const FEATURES: {
     /** `lib/mdxish.ts` — the document parser; the only site taking every group */
-    document: ("gemoji" | "mdxjsEsm" | "magicBlock" | "htmlBlockComponent" | "jsxTable" | "legacyVariable" | "looseHtmlEntity" | "mdxComponent" | "jsxComment" | "mdxExpressionLenient" | "mdxExpression" | "emptyTaskListItem")[];
+    document: ("gemoji" | "mdxjsEsm" | "magicBlock" | "headingId" | "htmlBlockComponent" | "jsxTable" | "legacyVariable" | "looseHtmlEntity" | "mdxComponent" | "jsxComment" | "mdxExpressionLenient" | "mdxExpression" | "emptyTaskListItem")[];
     /**
      * `components/utils.ts` — re-parses a component body, which should tokenize
      * like the document around it: when the two drifted a `<Table>` in a
      * `<Callout>` lost every row (CX-3705).
      */
-    componentBody: ("gemoji" | "mdxjsEsm" | "magicBlock" | "htmlBlockComponent" | "jsxTable" | "legacyVariable" | "looseHtmlEntity" | "mdxComponent" | "jsxComment" | "mdxExpressionLenient" | "mdxExpression" | "emptyTaskListItem")[];
+    componentBody: ("gemoji" | "mdxjsEsm" | "magicBlock" | "headingId" | "htmlBlockComponent" | "jsxTable" | "legacyVariable" | "looseHtmlEntity" | "mdxComponent" | "jsxComment" | "mdxExpressionLenient" | "mdxExpression" | "emptyTaskListItem")[];
     /**
      * `lib/mdxishTags.ts` — collects component names, so nothing inline is needed.
      * Omits `htmlBlockComponent` deliberately since it's not a custom component,
      * and no components are meant to be nested inside it (it's just for raw HTML).
      */
-    tags: ("gemoji" | "mdxjsEsm" | "magicBlock" | "jsxTable" | "legacyVariable" | "looseHtmlEntity" | "mdxComponent" | "jsxComment" | "mdxExpressionLenient" | "mdxExpression" | "emptyTaskListItem")[];
+    tags: ("gemoji" | "mdxjsEsm" | "magicBlock" | "headingId" | "jsxTable" | "legacyVariable" | "looseHtmlEntity" | "mdxComponent" | "jsxComment" | "mdxExpressionLenient" | "mdxExpression" | "emptyTaskListItem")[];
     /** `tables/mdxish-tables.ts` — table cells */
-    tableCell: ("gemoji" | "mdxjsEsm" | "magicBlock" | "htmlBlockComponent" | "jsxTable" | "legacyVariable" | "looseHtmlEntity" | "mdxComponent" | "jsxComment" | "mdxExpressionLenient" | "mdxExpression" | "emptyTaskListItem")[];
+    tableCell: ("gemoji" | "mdxjsEsm" | "magicBlock" | "headingId" | "htmlBlockComponent" | "jsxTable" | "legacyVariable" | "looseHtmlEntity" | "mdxComponent" | "jsxComment" | "mdxExpressionLenient" | "mdxExpression" | "emptyTaskListItem")[];
     /** `magic-blocks` — legacy content, no components */
-    magicBlockBody: ("gemoji" | "mdxjsEsm" | "magicBlock" | "htmlBlockComponent" | "jsxTable" | "legacyVariable" | "looseHtmlEntity" | "mdxComponent" | "jsxComment" | "mdxExpressionLenient" | "mdxExpression" | "emptyTaskListItem")[];
+    magicBlockBody: ("gemoji" | "mdxjsEsm" | "magicBlock" | "headingId" | "htmlBlockComponent" | "jsxTable" | "legacyVariable" | "looseHtmlEntity" | "mdxComponent" | "jsxComment" | "mdxExpressionLenient" | "mdxExpression" | "emptyTaskListItem")[];
     /** `magic-blocks` — api-header titles */
-    apiHeaderTitle: ("gemoji" | "mdxjsEsm" | "magicBlock" | "htmlBlockComponent" | "jsxTable" | "legacyVariable" | "looseHtmlEntity" | "mdxComponent" | "jsxComment" | "mdxExpressionLenient" | "mdxExpression" | "emptyTaskListItem")[];
+    apiHeaderTitle: ("gemoji" | "mdxjsEsm" | "magicBlock" | "headingId" | "htmlBlockComponent" | "jsxTable" | "legacyVariable" | "looseHtmlEntity" | "mdxComponent" | "jsxComment" | "mdxExpressionLenient" | "mdxExpression" | "emptyTaskListItem")[];
     /**
      * `lib/stripComments.ts` — parses only to strip comments, then re-stringifies,
      * so it needs the tokenizers that keep a construct in one piece across the
      * round trip.
      * No inline syntax: nothing here rewrites prose, and magic blocks are already excluded.
      */
-    stripComments: ("gemoji" | "mdxjsEsm" | "htmlBlockComponent" | "jsxTable" | "legacyVariable" | "looseHtmlEntity" | "mdxComponent" | "jsxComment" | "mdxExpressionLenient" | "mdxExpression" | "emptyTaskListItem")[];
+    stripComments: ("gemoji" | "mdxjsEsm" | "headingId" | "htmlBlockComponent" | "jsxTable" | "legacyVariable" | "looseHtmlEntity" | "mdxComponent" | "jsxComment" | "mdxExpressionLenient" | "mdxExpression" | "emptyTaskListItem")[];
 };
 /**
  * Builds the extension lists for an MDXish parser. `features` is an unordered

package/dist/lib/utils/mdxish/mdxish-variables.d.ts

@@ -3,8 +3,9 @@
  * so both engines agree. Body text differs on empty values: `Variable` falls back to the default.
  *
  * Legacy `<<...>>` is valid inside a quoted attribute but deliberately left literal — attributes are
- * an MDX surface, and `{user.*}` is the syntax authors use there.
+ * an MDX surface, and `{user.*}` is the syntax authors use there. Image alt is the exception, resolved
+ * in the same pass so a substituted value is never rescanned (RM-10865).
  */
-export declare function resolveAttributeVariables(value: string, user: Record<string, unknown>): string;
+export declare function resolveAttributeVariables(value: string, user: Record<string, unknown>, isImageAlt?: boolean): string;
 /** Whether an attribute expression's source is a bare `user.*` reference, left for render-time substitution. */
 export declare const isBareVariableReference: (source: string) => boolean;