Skip to content

Show LaTeX math expressions in haddockToMarkdown #4658

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 16, 2025
Merged

Show LaTeX math expressions in haddockToMarkdown #4658

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
74a72ae
Show LaTeX math expressions in haddockToMarkdown
webdevred Jul 9, 2025
82c8023
Do backticks for inline math and fenced latex blocks for math blocks
webdevred Jul 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions ghcide/src/Development/IDE/Spans/Common.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,11 +190,10 @@ haddockToMarkdown (H.DocOrderedList things) =
haddockToMarkdown (H.DocDefList things)
= '\n' : (unlines $ map (\(term, defn) -> "+ **" ++ haddockToMarkdown term ++ "**: " ++ haddockToMarkdown defn) things)

-- we cannot render math by default
haddockToMarkdown (H.DocMathInline _)
= "*cannot render inline math formula*"
haddockToMarkdown (H.DocMathDisplay _)
= "\n\n*cannot render display math formula*\n\n"
haddockToMarkdown (H.DocMathInline s)
= "$" ++ s ++ "$"
haddockToMarkdown (H.DocMathDisplay s)
= "\n$$\n" ++ s ++ "\n$$\n"

-- TODO: render tables
haddockToMarkdown (H.DocTable _t)
Expand Down
Loading