@readme/markdown 13.2.0 → 13.4.0

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

@@ -0,0 +1,8 @@
+import type { Root } from 'hast';
+/**
+ * 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;
+export default generateSlugForHeadings;

package/dist/processor/transform/mdxish/preprocess-jsx-expressions.d.ts

@@ -21,6 +21,18 @@ export type JSXContext = Record<string, unknown>;
  * ```
  */
 export declare function evaluateExpression(expression: string, context: JSXContext): any;
+/**
+ * Removes JSX-style comments (e.g., { /* comment *\/ }) from content.
+ *
+ * @param content
+ * @returns Content with JSX comments removed
+ * @example
+ * ```typescript
+ * removeJSXComments('Text { /* comment *\/ } more text')
+ * // Returns: 'Text  more text'
+ * ```
+ */
+export declare function removeJSXComments(content: string): string;
 /**
  * Preprocesses JSX-like expressions in markdown before parsing.
  * Inline expressions are handled separately; attribute expressions are processed here.

package/dist/processor/transform/mdxish/variables-code.d.ts

@@ -0,0 +1,14 @@
+import type { Variables } from '../../../types';
+import type { Plugin } from 'unified';
+interface Options {
+    variables?: Variables;
+}
+/**
+ * A remark mdast plugin that resolves legacy variables <<...>> and MDX variables {user.*} inside code and inline code nodes
+ * to their values. Uses regexes from the readme variable to search for variables in the code string.
+ *
+ * This is needed because variables in code blocks and inline cannot be tokenized, and also we need to maintain the code string
+ * in the code nodes. This enables engine side variable resolution in codes which improves UX
+ */
+declare const variablesCodeResolver: Plugin<[Options?]>;
+export default variablesCodeResolver;

package/dist/processor/transform/mdxish/variables-text.d.ts

@@ -1,7 +1,11 @@
 import type { Plugin } from 'unified';
 /**
- * A remark plugin that parses {user.<field>} patterns from text nodes
- * without requiring remarkMdx. Creates Variable nodes for runtime resolution.
+ * A remark plugin that parses {user.<field>} patterns from text nodes and
+ * mdxTextExpression nodes, creating Variable nodes for runtime resolution.
+ *
+ * Handles both:
+ * - `text` nodes: when safeMode is true or after expression evaluation
+ * - `mdxTextExpression` nodes: when mdxExpression has parsed {user.*} before evaluation
  *
  * Supports any user field: name, email, email_verified, exp, iat, etc.
  */

package/package.json

@@ -2,7 +2,7 @@
   "name": "@readme/markdown",
   "description": "ReadMe's React-based Markdown parser",
   "author": "Rafe Goldberg <rafe@readme.io>",
-  "version": "13.2.0",
+  "version": "13.4.0",
   "main": "dist/main.node.js",
   "types": "dist/index.d.ts",
   "browser": "dist/main.js",
@@ -34,6 +34,7 @@
     "emoji-regex": "^10.2.1",
     "estree-util-value-to-estree": "^3.1.1",
     "gemoji": "^8.1.0",
+    "github-slugger": "^2.0.0",
     "hast-util-from-html": "^2.0.1",
     "hast-util-sanitize": "^4.0.0",
     "hastscript": "^9.0.0",
@@ -162,7 +163,7 @@
       },
       {
         "path": "dist/main.node.js",
-        "maxSize": "805KB"
+        "maxSize": "810KB"
       }
     ]
   },