From 27da314bd4da09d33131e56dc71caf934769f014 Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Thu, 4 Dec 2025 20:03:33 +0000 Subject: [PATCH 1/4] Add documentation for escaping dollar signs in LaTeX Co-Authored-By: Fern Support --- .../component-library/writing-content/markdown-media.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/fern/products/docs/pages/component-library/writing-content/markdown-media.mdx b/fern/products/docs/pages/component-library/writing-content/markdown-media.mdx index d0ea98f08..c7abc44a2 100644 --- a/fern/products/docs/pages/component-library/writing-content/markdown-media.mdx +++ b/fern/products/docs/pages/component-library/writing-content/markdown-media.mdx @@ -187,6 +187,10 @@ $$ \,d\xi $$ +### Escaping dollar signs + +Text between two dollar signs is rendered as a LaTeX equation. For example, `$10 this is sample text $20` renders as $10 this is sample text $20. To display dollar signs as literal text, escape them with a backslash: `\$10 this is sample text \$20` renders as \$10 this is sample text \$20. + ## Diagrams Fern supports creating diagrams within your Markdown using [Mermaid](https://mermaid.js.org/). Mermaid offers a variety of diagrams, including flowcharts, entity-relationship models, and Gantt charts. To include a Mermaid diagram in your Markdown file, create a codeblock marked with `mermaid`. From 80a8bcca391446a70c0816bdd07ec343624ab42d Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Thu, 4 Dec 2025 18:10:36 -0500 Subject: [PATCH 2/4] clarify explanation and add better example --- .../writing-content/markdown-media.mdx | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/fern/products/docs/pages/component-library/writing-content/markdown-media.mdx b/fern/products/docs/pages/component-library/writing-content/markdown-media.mdx index c7abc44a2..172ab38ee 100644 --- a/fern/products/docs/pages/component-library/writing-content/markdown-media.mdx +++ b/fern/products/docs/pages/component-library/writing-content/markdown-media.mdx @@ -187,9 +187,23 @@ $$ \,d\xi $$ -### Escaping dollar signs +### Displaying literal dollar signs -Text between two dollar signs is rendered as a LaTeX equation. For example, `$10 this is sample text $20` renders as $10 this is sample text $20. To display dollar signs as literal text, escape them with a backslash: `\$10 this is sample text \$20` renders as \$10 this is sample text \$20. +Since dollar signs trigger LaTeX rendering, text containing dollar amounts may accidentally render as math equations. To display literal dollar signs in your documentation (like prices, budgets, costs, or financial data), escape them with a backslash (`\`): + +
+
+ Without escaping: The product costs $10 and shipping is $5 + + With escaping: The product costs \$10 and shipping is \$5 +
+
+ + +```markdown Markdown wordWrap +Without escaping: The product costs $10 and shipping is $5 +With escaping: The product costs \$10 and shipping is \$5 +``` ## Diagrams Fern supports creating diagrams within your Markdown using [Mermaid](https://mermaid.js.org/). Mermaid offers a variety of diagrams, including flowcharts, entity-relationship models, and Gantt charts. To include a Mermaid diagram in your Markdown file, create a codeblock marked with `mermaid`. From 6cd6c30db843a8fd1cfc2cc144291ab1d15426e1 Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Thu, 4 Dec 2025 23:14:26 +0000 Subject: [PATCH 3/4] Remove 'accidentally' per Vale style guide Co-Authored-By: Fern Support --- .../pages/component-library/writing-content/markdown-media.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/products/docs/pages/component-library/writing-content/markdown-media.mdx b/fern/products/docs/pages/component-library/writing-content/markdown-media.mdx index 172ab38ee..fbdf59af3 100644 --- a/fern/products/docs/pages/component-library/writing-content/markdown-media.mdx +++ b/fern/products/docs/pages/component-library/writing-content/markdown-media.mdx @@ -189,7 +189,7 @@ $$ ### Displaying literal dollar signs -Since dollar signs trigger LaTeX rendering, text containing dollar amounts may accidentally render as math equations. To display literal dollar signs in your documentation (like prices, budgets, costs, or financial data), escape them with a backslash (`\`): +Since dollar signs trigger LaTeX rendering, text containing dollar amounts may render as math equations. To display literal dollar signs in your documentation (like prices, budgets, costs, or financial data), escape them with a backslash (`\`):
From 787bba4ea3074e8f76a21c7aa1e8af8a0290c237 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Thu, 4 Dec 2025 18:23:29 -0500 Subject: [PATCH 4/4] update explanation --- .../pages/component-library/writing-content/markdown-media.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/products/docs/pages/component-library/writing-content/markdown-media.mdx b/fern/products/docs/pages/component-library/writing-content/markdown-media.mdx index fbdf59af3..cb4acf0c3 100644 --- a/fern/products/docs/pages/component-library/writing-content/markdown-media.mdx +++ b/fern/products/docs/pages/component-library/writing-content/markdown-media.mdx @@ -189,7 +189,7 @@ $$ ### Displaying literal dollar signs -Since dollar signs trigger LaTeX rendering, text containing dollar amounts may render as math equations. To display literal dollar signs in your documentation (like prices, budgets, costs, or financial data), escape them with a backslash (`\`): +Text containing dollar amounts (like prices, budgets, or costs) may unintentionally render as math equations. To display literal dollar signs, escape them with a backslash (`\`):