@readme/markdown 11.12.0 → 11.13.0

package/dist/processor/transform/mdxish/mdxish-component-blocks.d.ts

@@ -1,6 +1,69 @@
 import type { Parent } from 'mdast';
 import type { MdxJsxAttribute } from 'mdast-util-mdx-jsx';
 import type { Plugin } from 'unified';
+/**
+ * Convert raw attribute string into mdxJsxAttribute entries.
+ * Handles both key-value attributes (theme="info") and boolean attributes (empty).
+ */
 export declare const parseAttributes: (raw: string) => MdxJsxAttribute[];
+/**
+ * Transform PascalCase HTML nodes into mdxJsxFlowElement nodes.
+ *
+ * Remark parses unknown/custom component tags as raw HTML nodes.
+ * These are the custom readme MDX syntax for components.
+ * This transformer identifies these patterns and converts them to proper MDX JSX elements so they
+ * can be accurately recognized and rendered later with their component definition code.
+ * Though for some tags, we need to handle them specially
+ *
+ * ## Supported HTML Structures
+ *
+ * ### 1. Self-closing tags
+ * ```
+ * <Component />
+ * ```
+ * Parsed as: `html: "<Component />"`
+ *
+ * ### 2. Self-contained blocks (entire component in single HTML node)
+ * ```
+ * <Button>Click me</Button>
+ * ```
+ * ```
+ * <Component>
+ *   <h2>Title</h2>
+ *   <p>Content</p>
+ * </Component>
+ * ```
+ * Parsed as: `html: "<Component>\n  <h2>Title</h2>\n  <p>Content</p>\n</Component>"`
+ * The opening tag, content, and closing tag are all captured in one HTML node.
+ *
+ * ### 3. Multi-sibling components (closing tag in a following sibling)
+ * Handles various structures where the closing tag is in a later sibling, such as:
+ *
+ * #### 3a. Block components (closing tag in sibling paragraph)
+ * ```
+ * <Callout>
+ * Some **markdown** content
+ * </Callout>
+ * ```
+ *
+ * #### 3b. Multi-paragraph components (closing tag several siblings away)
+ * ```
+ * <Callout>
+ *
+ * First paragraph
+ *
+ * Second paragraph
+ * </Callout>
+ * ```
+ *
+ * #### 3c. Nested components split by blank lines (closing tag embedded in HTML sibling)
+ * ```
+ * <Outer>
+ *   <Inner>content</Inner>
+ *
+ *   <Inner>content</Inner>
+ * </Outer>
+ * ```
+ */
 declare const mdxishComponentBlocks: Plugin<[], Parent>;
 export default mdxishComponentBlocks;

package/dist/processor/transform/mdxish/mdxish-mermaid.d.ts

@@ -0,0 +1,8 @@
+import type { Root } from 'hast';
+/**
+ * Rehype plugin for mdxish pipeline to add mermaid-render className to mermaid code blocks.
+ * The mermaid-render class is used to identify the mermaid diagrams elements for the
+ * mermaid library to transform. See components/CodeTabs/index.tsx for context
+ */
+declare const mdxishMermaidTransformer: () => (tree: Root) => Root;
+export default mdxishMermaidTransformer;

package/dist/processor/transform/mdxish/retain-boolean-attributes.d.ts

@@ -0,0 +1,9 @@
+import type { Plugin } from 'unified';
+/**
+ * Preserves boolean properties when passed to rehypeRaw because
+ * rehypeRaw converts boolean properties in nodes to strings (e.g. true -> ""),
+ * which can change the truthiness of the property. Hence we need to preserve the boolean properties.
+ */
+declare const preserveBooleanProperties: Plugin;
+declare const restoreBooleanProperties: Plugin;
+export { preserveBooleanProperties, restoreBooleanProperties };

package/package.json

@@ -2,7 +2,7 @@
   "name": "@readme/markdown",
   "description": "ReadMe's React-based Markdown parser",
   "author": "Rafe Goldberg <rafe@readme.io>",
-  "version": "11.12.0",
+  "version": "11.13.0",
   "main": "dist/main.node.js",
   "types": "dist/index.d.ts",
   "browser": "dist/main.js",