Skip to content

Commit 3e35847

Browse files
committed
README.md: Add a note about MathJax 3.x support
Refs #25.
1 parent 59b5243 commit 3e35847

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Also, you need to specify a configuration for MathJax. Please note that
4646
most of standard configuratons include `tex2jax` extension, which is not needed
4747
with this code.
4848

49-
Example of MathJax configuration:
49+
Example of configuration for MathJax 2.x:
5050

5151
```html
5252
<script type="text/x-mathjax-config">
@@ -58,6 +58,11 @@ MathJax.Hub.Config({
5858
</script>
5959
```
6060

61+
If you want to use MathJax 3.x, you need to teach it to understand 2.x-style
62+
`<script>` tags. See the [upgrading documentation] on how to do it.
63+
Alternatively, you may use the [Arithmatex] extension which has a generic
64+
output mode, that does not require such special configuration.
65+
6166
To pass the extension to Python-Markdown, use `mdx_math` as extension name.
6267
For example:
6368

@@ -76,6 +81,9 @@ $ echo "\(e^x\)" | python3 -m markdown -x mdx_math
7681
</p>
7782
```
7883

84+
[upgrading documentation]: https://docs.mathjax.org/en/latest/upgrading/v2.html#math-script-example
85+
[Arithmatex]: https://facelessuser.github.io/pymdown-extensions/extensions/arithmatex/
86+
7987
Math Delimiters
8088
---------------
8189

0 commit comments

Comments
 (0)