Skip to content

Commit 793809a

Browse files
committed
Recommend markdown-it-mathjax in README
1 parent c5d925f commit 793809a

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
1-
markdown-it-math
2-
================
3-
41
[![npm](https://img.shields.io/npm/v/markdown-it-math.svg)](https://www.npmjs.com/package/markdown-it-math)
52
[![Build Status](https://travis-ci.org/runarberg/markdown-it-math.svg?branch=master)](https://travis-ci.org/runarberg/markdown-it-math)
63

4+
**Note:** This is a general [markdown-it][markdown-it] math plugin. It
5+
was originally designed to render [MathML][mathml]. If you intend to
6+
use [MathJax][mathjax], [markdown-it-mathjax][markdown-it-mathjax]
7+
might be a better choise.
8+
9+
markdown-it-math
10+
================
11+
712
```md
813
Pythagoran theorem is $$a^2 + b^2 = c^2$$.
914

@@ -50,7 +55,7 @@ var options = {
5055
}
5156
```
5257

53-
(See [ascii2mathml](http://runarberg.github.io/ascii2mathml/) for reference about the default renderer).
58+
(See [ascii2mathml][ascii2mathml] for reference about the default renderer).
5459

5560

5661
Examples
@@ -68,7 +73,7 @@ md.render("$$40,2$$");
6873
// <p><math><mn>40,2</mn></math></p>
6974
```
7075

71-
Using [TeXZilla](http://fred-wang.github.io/TeXZilla/) as renderer
76+
Using [TeXZilla][texzilla] as renderer
7277

7378
```javascript
7479
var texzilla = require('texzilla');
@@ -114,3 +119,9 @@ e = sum_(n=0)^oo 1/n!
114119
```
115120

116121
[1]: https://github.com/markdown-it/markdown-it/blob/master/docs/development.md#why-my-inline-rule-is-not-executed
122+
[ascii2mathml]: http://runarberg.github.io/ascii2mathml/
123+
[mathjax]: https://www.mathjax.org/
124+
[mathml]: https://www.w3.org/TR/MathML/
125+
[markdown-it]: https://github.com/markdown-it/markdown-it
126+
[markdown-it-mathjax]: https://www.npmjs.com/package/markdown-it-mathjax
127+
[texzilla]: http://fred-wang.github.io/TeXZilla/

0 commit comments

Comments
 (0)