Skip to content

Swap backticks and dollar signs in inline math markup #21

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.

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 1 commit into
base: development
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions m2r2.py
Original file line number Diff line number Diff line change
Expand Up @@ -119,10 +119,10 @@ class RestInlineGrammar(mistune.InlineGrammar):
)
rest_role = re.compile(r":.*?:`.*?`|`[^`]+`:.*?:")
rest_link = re.compile(r"`[^`]*?`_")
inline_math = re.compile(r"`\$(.*?)\$`")
inline_math = re.compile(r"\$`(.*?)`\$")
eol_literal_marker = re.compile(r"(\s+)?::\s*$")
# add colon and space as special text
text = re.compile(r"^[\s\S]+?(?=[\\<!\[:_*`~ ]|https?://| {2,}\n|$)")
# add colon, dollar and space as special text
text = re.compile(r"^[\s\S]+?(?=[\\<!\[:_*`~$ ]|https?://| {2,}\n|$)")
# __word__ or **word**
double_emphasis = re.compile(r"^([_*]){2}(?P<text>[\s\S]+?)\1{2}(?!\1)")
# _word_ or *word*
Expand Down
6 changes: 3 additions & 3 deletions tests/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ __content__

[A link to GitHub](http://github.com/)

This is `$E = mc^2$` inline math.
This is $`E = mc^2`$ inline math.

This first math `$x^2$` in this line will render. This one `$z^3$` should as well.
This first math $`x^2`$ in this line will render. This one $`z^3`$ should as well.

Also within parentheses (`$x^2$`) and (`$z^3$`).
Also within parentheses ($`x^2`$) and ($`z^3`$).

```mermaid
graph TD;
Expand Down
2 changes: 1 addition & 1 deletion tests/test_cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -136,5 +136,5 @@ def test_disable_inline_math(self):
sys.argv = [sys.argv[0], '--disable-inline-math', '--dry-run', test_md]
with patch(_builtin + '.print') as m:
main()
self.assertIn('``$E = mc^2$``', m.call_args[0][0])
self.assertIn(r'$\ ``E = mc^2``\ $', m.call_args[0][0])
self.assertNotIn(':math:', m.call_args[0][0])
6 changes: 3 additions & 3 deletions tests/test_renderer.py
Original file line number Diff line number Diff line change
Expand Up @@ -264,14 +264,14 @@ def test_code_with_rest_link(self):
self.assertEqual(out, '\na ``code`` and `RefLink <a>`_ here.\n')

def test_inline_math(self):
src = 'this is `$E = mc^2$` inline math.'
src = 'this is $`E = mc^2`$ inline math.'
out = self.conv(src)
self.assertEqual(out, '\nthis is :math:`E = mc^2` inline math.\n')

def test_disable_inline_math(self):
src = 'this is `$E = mc^2$` inline math.'
src = 'this is $`E = mc^2`$ inline math.'
out = self.conv(src, disable_inline_math=True)
self.assertEqual(out, '\nthis is ``$E = mc^2$`` inline math.\n')
self.assertEqual(out, '\nthis is $\\ ``E = mc^2``\\ $ inline math.\n')

def test_inline_html(self):
src = 'this is <s>html</s>.'
Expand Down