@readme/markdown 14.1.4 → 14.2.0

package/dist/lib/compile.d.ts

@@ -2,8 +2,9 @@ import type { CompileOptions } from '@mdx-js/mdx';
 export type CompileOpts = CompileOptions & {
     components?: Record<string, string>;
     copyButtons?: boolean;
+    hardBreaks?: boolean;
     missingComponents?: 'ignore' | 'throw';
     useTailwind?: boolean;
 };
-declare const compile: (text: string, { components, missingComponents, copyButtons, useTailwind, ...opts }?: CompileOpts) => string;
+declare const compile: (text: string, { components, missingComponents, copyButtons, useTailwind, hardBreaks, ...opts }?: CompileOpts) => string;
 export default compile;

package/dist/main.js

@@ -53325,9 +53325,16 @@ function formatHtmlForMdxish(html) {
     }
     // Removes the leading/trailing newlines
     let cleaned = processed.replace(/^\s*\n|\n\s*$/g, '');
-    // Convert literal \n sequences to actual newlines BEFORE processing backticks
-    // This prevents the backtick unescaping regex from incorrectly matching \n sequences
-    cleaned = cleaned.replace(/\\n/g, '\n');
+    // Convert literal \n sequences to actual newlines only inside <pre> and <code>.
+    // Because <pre> needs to respect the newline visual and
+    // escape characters should be processed in the <code> tag.
+    //
+    // We don't want to unescape every \n because it might break the HTML & cause errors
+    // Example: <script>console.log("\n");</script>
+    // Would get turned into: <script>console.log("
+    // ");</script>
+    // which is invalid javascript and will cause error
+    cleaned = cleaned.replace(/(<(pre|code)\b[^>]*>)([\s\S]*?)(<\/\2>)/gi, (_m, open, _tag, inner, close) => open + inner.replace(/\\n/g, '\n') + close);
     // Unescape backticks: \` -> ` (users escape backticks in template literals)
     // Handle both cases: \` (adjacent) and \ followed by ` (split by markdown parser)
     cleaned = cleaned.replace(/\\`/g, '`');
@@ -84802,6 +84809,63 @@ function rehypeSanitize(options) {
   }
 }
 
+;// ./node_modules/mdast-util-newline-to-break/lib/index.js
+/**
+ * @typedef {import('mdast').Nodes} Nodes
+ * @typedef {import('mdast-util-find-and-replace').ReplaceFunction} ReplaceFunction
+ */
+
+
+
+/**
+ * Turn normal line endings into hard breaks.
+ *
+ * @param {Nodes} tree
+ *   Tree to change.
+ * @returns {undefined}
+ *   Nothing.
+ */
+function newlineToBreak(tree) {
+  findAndReplace(tree, [/\r?\n|\r/g, lib_replace])
+}
+
+/**
+ * Replace line endings.
+ *
+ * @type {ReplaceFunction}
+ */
+function lib_replace() {
+  return {type: 'break'}
+}
+
+;// ./node_modules/remark-breaks/lib/index.js
+/**
+ * @typedef {import('mdast').Root} Root
+ */
+
+
+
+/**
+ * Support hard breaks without needing spaces or escapes (turns enters into
+ * `<br>`s).
+ *
+ * @returns
+ *   Transform.
+ */
+function remarkBreaks() {
+  /**
+   * Transform.
+   *
+   * @param {Root} tree
+   *   Tree.
+   * @returns {undefined}
+   *   Nothing.
+   */
+  return function (tree) {
+    newlineToBreak(tree)
+  }
+}
+
 ;// ./errors/mdx-syntax-error.ts
 class MdxSyntaxError extends SyntaxError {
     original = null;
@@ -87607,6 +87671,7 @@ const tocHastToMdx = (toc, components, variables) => {
 
 
 
+
 const sanitizeSchema = cjs_default()(defaultSchema, {
     attributes: {
         a: ['target'],
@@ -87615,12 +87680,13 @@ const sanitizeSchema = cjs_default()(defaultSchema, {
         href: ['doc', 'ref', 'blog', 'changelog', 'page'],
     },
 });
-const compile_compile = (text, { components = {}, missingComponents, copyButtons, useTailwind, ...opts } = {}) => {
+const compile_compile = (text, { components = {}, missingComponents, copyButtons, useTailwind, hardBreaks, ...opts } = {}) => {
     // Destructure at runtime to avoid circular dependency issues
     const { codeTabsTransformer, ...transforms } = defaultTransforms;
     const remarkPlugins = [
         remarkFrontmatter,
         remarkGfm,
+        ...(hardBreaks ? [remarkBreaks] : []),
         ...Object.values(transforms),
         [codeTabsTransformer, { copyButtons }],
         [
@@ -94026,63 +94092,6 @@ function rehypeStringify(options) {
   }
 }
 
-;// ./node_modules/mdast-util-newline-to-break/lib/index.js
-/**
- * @typedef {import('mdast').Nodes} Nodes
- * @typedef {import('mdast-util-find-and-replace').ReplaceFunction} ReplaceFunction
- */
-
-
-
-/**
- * Turn normal line endings into hard breaks.
- *
- * @param {Nodes} tree
- *   Tree to change.
- * @returns {undefined}
- *   Nothing.
- */
-function newlineToBreak(tree) {
-  findAndReplace(tree, [/\r?\n|\r/g, lib_replace])
-}
-
-/**
- * Replace line endings.
- *
- * @type {ReplaceFunction}
- */
-function lib_replace() {
-  return {type: 'break'}
-}
-
-;// ./node_modules/remark-breaks/lib/index.js
-/**
- * @typedef {import('mdast').Root} Root
- */
-
-
-
-/**
- * Support hard breaks without needing spaces or escapes (turns enters into
- * `<br>`s).
- *
- * @returns
- *   Transform.
- */
-function remarkBreaks() {
-  /**
-   * Transform.
-   *
-   * @param {Root} tree
-   *   Tree.
-   * @returns {undefined}
-   *   Nothing.
-   */
-  return function (tree) {
-    newlineToBreak(tree)
-  }
-}
-
 ;// ./processor/plugin/flatten-table-cell-paragraphs.ts
 
 /** List elements that cause margin issues when adjacent to paragraphs */

package/dist/main.node.js

@@ -73519,9 +73519,16 @@ function formatHtmlForMdxish(html) {
     }
     // Removes the leading/trailing newlines
     let cleaned = processed.replace(/^\s*\n|\n\s*$/g, '');
-    // Convert literal \n sequences to actual newlines BEFORE processing backticks
-    // This prevents the backtick unescaping regex from incorrectly matching \n sequences
-    cleaned = cleaned.replace(/\\n/g, '\n');
+    // Convert literal \n sequences to actual newlines only inside <pre> and <code>.
+    // Because <pre> needs to respect the newline visual and
+    // escape characters should be processed in the <code> tag.
+    //
+    // We don't want to unescape every \n because it might break the HTML & cause errors
+    // Example: <script>console.log("\n");</script>
+    // Would get turned into: <script>console.log("
+    // ");</script>
+    // which is invalid javascript and will cause error
+    cleaned = cleaned.replace(/(<(pre|code)\b[^>]*>)([\s\S]*?)(<\/\2>)/gi, (_m, open, _tag, inner, close) => open + inner.replace(/\\n/g, '\n') + close);
     // Unescape backticks: \` -> ` (users escape backticks in template literals)
     // Handle both cases: \` (adjacent) and \ followed by ` (split by markdown parser)
     cleaned = cleaned.replace(/\\`/g, '`');
@@ -104996,6 +105003,63 @@ function rehypeSanitize(options) {
   }
 }
 
+;// ./node_modules/mdast-util-newline-to-break/lib/index.js
+/**
+ * @typedef {import('mdast').Nodes} Nodes
+ * @typedef {import('mdast-util-find-and-replace').ReplaceFunction} ReplaceFunction
+ */
+
+
+
+/**
+ * Turn normal line endings into hard breaks.
+ *
+ * @param {Nodes} tree
+ *   Tree to change.
+ * @returns {undefined}
+ *   Nothing.
+ */
+function newlineToBreak(tree) {
+  findAndReplace(tree, [/\r?\n|\r/g, lib_replace])
+}
+
+/**
+ * Replace line endings.
+ *
+ * @type {ReplaceFunction}
+ */
+function lib_replace() {
+  return {type: 'break'}
+}
+
+;// ./node_modules/remark-breaks/lib/index.js
+/**
+ * @typedef {import('mdast').Root} Root
+ */
+
+
+
+/**
+ * Support hard breaks without needing spaces or escapes (turns enters into
+ * `<br>`s).
+ *
+ * @returns
+ *   Transform.
+ */
+function remarkBreaks() {
+  /**
+   * Transform.
+   *
+   * @param {Root} tree
+   *   Tree.
+   * @returns {undefined}
+   *   Nothing.
+   */
+  return function (tree) {
+    newlineToBreak(tree)
+  }
+}
+
 ;// ./errors/mdx-syntax-error.ts
 class MdxSyntaxError extends SyntaxError {
     original = null;
@@ -107801,6 +107865,7 @@ const tocHastToMdx = (toc, components, variables) => {
 
 
 
+
 const sanitizeSchema = cjs_default()(defaultSchema, {
     attributes: {
         a: ['target'],
@@ -107809,12 +107874,13 @@ const sanitizeSchema = cjs_default()(defaultSchema, {
         href: ['doc', 'ref', 'blog', 'changelog', 'page'],
     },
 });
-const compile_compile = (text, { components = {}, missingComponents, copyButtons, useTailwind, ...opts } = {}) => {
+const compile_compile = (text, { components = {}, missingComponents, copyButtons, useTailwind, hardBreaks, ...opts } = {}) => {
     // Destructure at runtime to avoid circular dependency issues
     const { codeTabsTransformer, ...transforms } = defaultTransforms;
     const remarkPlugins = [
         remarkFrontmatter,
         remarkGfm,
+        ...(hardBreaks ? [remarkBreaks] : []),
         ...Object.values(transforms),
         [codeTabsTransformer, { copyButtons }],
         [
@@ -114220,63 +114286,6 @@ function rehypeStringify(options) {
   }
 }
 
-;// ./node_modules/mdast-util-newline-to-break/lib/index.js
-/**
- * @typedef {import('mdast').Nodes} Nodes
- * @typedef {import('mdast-util-find-and-replace').ReplaceFunction} ReplaceFunction
- */
-
-
-
-/**
- * Turn normal line endings into hard breaks.
- *
- * @param {Nodes} tree
- *   Tree to change.
- * @returns {undefined}
- *   Nothing.
- */
-function newlineToBreak(tree) {
-  findAndReplace(tree, [/\r?\n|\r/g, lib_replace])
-}
-
-/**
- * Replace line endings.
- *
- * @type {ReplaceFunction}
- */
-function lib_replace() {
-  return {type: 'break'}
-}
-
-;// ./node_modules/remark-breaks/lib/index.js
-/**
- * @typedef {import('mdast').Root} Root
- */
-
-
-
-/**
- * Support hard breaks without needing spaces or escapes (turns enters into
- * `<br>`s).
- *
- * @returns
- *   Transform.
- */
-function remarkBreaks() {
-  /**
-   * Transform.
-   *
-   * @param {Root} tree
-   *   Tree.
-   * @returns {undefined}
-   *   Nothing.
-   */
-  return function (tree) {
-    newlineToBreak(tree)
-  }
-}
-
 ;// ./processor/plugin/flatten-table-cell-paragraphs.ts
 
 /** List elements that cause margin issues when adjacent to paragraphs */