@readme/markdown 15.9.4 → 15.10.0

package/dist/processor/compile/heading.d.ts

@@ -0,0 +1,5 @@
+import type { Heading, Parents } from 'mdast';
+import type { Info, State } from 'mdast-util-to-markdown';
+/** Writes an explicit heading id back as ` {#id}`. A setext heading, written for a line break, can't carry one. */
+declare const heading: (node: Heading, parent: Parents | undefined, state: State, info: Info) => string;
+export default heading;

package/dist/processor/transform/mdxish/heading-ids.d.ts

@@ -0,0 +1,14 @@
+import type { Root } from 'mdast';
+import type { Plugin } from 'unified';
+declare module 'vfile' {
+    interface DataMap {
+        /** Heading ids set by `{#id}`, which the slug pass must not hand to another heading. */
+        explicitHeadingIds?: Set<string>;
+    }
+}
+/**
+ * Records every heading id set by `{#id}`, so the slug pass never gives one to another heading.
+ * Warns when two headings share an id, since links can only reach the first.
+ */
+declare const headingIdsTransformer: Plugin<[], Root>;
+export default headingIdsTransformer;

package/dist/processor/transform/mdxish/heading-slugs.d.ts

@@ -1,8 +1,9 @@
 import type { Root } from 'hast';
+import type { VFile } from 'vfile';
 /**
  * Rehype plugin that constructs ids for headings
  * Id's are used to construct slug anchor links & Table of Contents during rendering
  * Use the text / nodes that make up the heading to generate the id
  */
-declare const generateSlugForHeadings: () => (tree: Root) => Root;
+declare const generateSlugForHeadings: () => (tree: Root, file: VFile) => Root;
 export default generateSlugForHeadings;

package/dist/processor/utils.d.ts

@@ -1,5 +1,5 @@
 import type { Root as HastRoot } from 'hast';
-import type { Node, Root as MdastRoot, Root } from 'mdast';
+import type { Heading, Node, Root as MdastRoot, Root, Text } from 'mdast';
 import type { MdxJsxFlowElement, MdxJsxTextElement, MdxjsEsm } from 'mdast-util-mdx';
 import type { MdxJsxAttribute } from 'mdast-util-mdx-jsx';
 import type { Point, Position } from 'unist';
@@ -59,6 +59,14 @@ export declare const getHProps: <T>(node: Node) => T;
  * @returns {Array} array of hProperty keys
  */
 export declare const getHPropKeys: <T>(node: Node) => string[];
+/** Turn a non-renderable evaluation result into a text node. */
+export declare const createTextNode: (result: unknown, position: Position | undefined) => Text;
+/**
+ * The id a heading's trailing `{#id}` set, when it is one the `{#id}` syntax can spell.
+ *
+ * Ids may use letters, numbers, `-`, `_`, `.` and `:`; anything else, like `x y`, is dropped.
+ */
+export declare const explicitHeadingId: (node: Heading) => string | undefined;
 /**
  * Gets the attributes of an MDX element and returns them as an object of hProperties.
  *