Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Dec 4, 2025

Summary

Adds a new subsection under the LaTeX documentation explaining how to escape dollar signs to prevent unintended LaTeX rendering. This addresses the issue where text between two dollar signs is rendered as a LaTeX equation.

The documentation includes:

  • An explanation of when LaTeX rendering is triggered
  • Visual examples showing the difference between escaped and unescaped dollar signs
  • The solution using backslash escaping (\$)

Updates since last revision

  • Removed "accidentally" per Vale style guide feedback

Review & Testing Checklist for Human

  • Verify on the preview deployment that the highlight-frame div renders correctly with the before/after examples
  • Confirm the unescaped example (The product costs $10 and shipping is $5) demonstrates the LaTeX rendering issue
  • Verify the escaped example (\$10 and \$5) displays literal dollar signs

Test plan: Navigate to the Rich media in Markdown page on the preview deployment and verify both the visual example and the markdown code block render as expected.

Notes

Link to Devin run: https://app.devin.ai/sessions/b52e6865c96c489c92d8b39304a465ed
Requested by: Fern Support (info@buildwithfern.com)

Co-Authored-By: Fern Support <info@buildwithfern.com>
@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@github-actions
Copy link
Contributor

github-actions bot commented Dec 4, 2025


### 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 (`\`):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[FernStyles.Adverbs] Remove 'accidentally' if it's not important to the meaning of the statement.

@github-actions
Copy link
Contributor

github-actions bot commented Dec 4, 2025

Co-Authored-By: Fern Support <info@buildwithfern.com>
@github-actions
Copy link
Contributor

github-actions bot commented Dec 4, 2025

@github-actions
Copy link
Contributor

github-actions bot commented Dec 4, 2025

@Ryan-Amirthan Ryan-Amirthan self-requested a review December 4, 2025 23:27
@devalog devalog merged commit 97dc8cf into main Dec 4, 2025
2 checks passed
@devalog devalog deleted the devin/1764878554-latex-escape-docs branch December 4, 2025 23:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants