@readme/markdown 13.1.4 → 13.3.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/terminate-html-flow-blocks.d.ts

@@ -9,13 +9,13 @@
  * @link https://spec.commonmark.org/0.29/#html-blocks
  *
  * This preprocessor inserts a blank line after standalone HTML lines when the
- * next line is non-blank, ensuring micromark's HTML flow tokenizer terminates
- * and subsequent content is parsed independently.
+ * next line is non-blank and not an HTML construct (because they still might be part of the HTML flow),
+ * ensuring micromark's HTML flow tokenizer terminates and subsequent content is parsed independently.
  *
- * Only targets non-indented lines with lowercase tag names. Uppercase tags
+ * Conditions:
+ * 1. Only targets non-indented lines with lowercase tag names. Uppercase tags
  * (e.g., `<Table>`, `<MyComponent>`) are JSX custom components and don't
  * trigger CommonMark HTML blocks, so they are left untouched.
- *
- * Lines inside fenced code blocks are skipped entirely.
+ * 2. Lines inside protected blocks (e.g., code blocks) should be left untouched.
  */
 export declare function terminateHtmlFlowBlocks(content: string): string;

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/package.json

@@ -2,7 +2,7 @@
   "name": "@readme/markdown",
   "description": "ReadMe's React-based Markdown parser",
   "author": "Rafe Goldberg <rafe@readme.io>",
-  "version": "13.1.4",
+  "version": "13.3.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"
       }
     ]
   },