Skip to content

Fix equation rendering #137

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Fix equation rendering #137

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ed735e6
Create markdown classes for inline and block equations
EmilyBourne May 23, 2025
5dcbf02
Create equation nodes for formula tag
EmilyBourne May 23, 2025
bcd6a59
Make expressions more robust following PR review
EmilyBourne May 23, 2025
6f49f11
Use indent
EmilyBourne May 23, 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
19 changes: 19 additions & 0 deletions mkdoxy/markdown.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,3 +224,22 @@ def render(self, f: MdRenderer, indent: str):
f.write("|")
is_first = False
f.write("\n\n")


class MdInlineEquation(Md):
def __init__(self, equation: str):
self.equation = equation

def render(self, f: MdRenderer, indent: str):
if self.equation:
f.write(rf"\({self.equation}\)")


class MdBlockEquation(Md):
def __init__(self, equation: str):
self.equation = equation

def render(self, f: MdRenderer, indent: str):
f.write("\n")
f.write(rf"\[{self.equation}\]")
f.write("\n")
8 changes: 8 additions & 0 deletions mkdoxy/xml_parser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,12 @@
Code,
Md,
MdBlockQuote,
MdBlockEquation,
MdBold,
MdCodeBlock,
MdHeader,
MdImage,
MdInlineEquation,
MdItalic,
MdLink,
MdList,
Expand Down Expand Up @@ -277,6 +279,12 @@ def paras(self, p: Element, italic: bool = False) -> [Md]:

elif item.tag == "emphasis":
ret.append(MdItalic(self.paras(item)))
elif item.tag == "formula":
equation = item.text.strip("$ ")
if len(p) == 1 and item.tail is None:
ret.append(MdBlockEquation(equation))
else:
ret.append(MdInlineEquation(equation))

if item.tail:
if italic:
Expand Down