Skip to content

Commit 65f91de

Browse files
Update docs for hexo-renderer-pandoc
1 parent 369588a commit 65f91de

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

source/docs/third-party-services/math-equations.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -69,17 +69,13 @@ For now, NexT provides two rendering engines for displaying Math Equations: [Mat
6969
- MathJax is a JavaScript display engine for mathematics that works in all browsers. It is highly modular on input and output. Use MathML, TeX, and ASCIImath as input and produce HTML+CSS, SVG, or MathML as output.
7070
- [KaTeX is a faster](https://www.intmath.com/cg5/katex-mathjax-comparison.php) math rendering engine compared to MathJax 3. And it could survive without JavaScript. But, for now [KaTeX supports less features](https://github.com/KaTeX/KaTeX/wiki/Things-that-KaTeX-does-not-(yet)-support) than MathJax. Here is a list of [TeX functions supported by KaTeX](https://katex.org/docs/supported.html).
7171

72-
Firstly, you need to choose a rendering engine and turn on `enable` for it in {% label primary@NexT config file %}. Then you need to install the **corresponding Hexo Renderer** to fully support the display of Math Equations - Only turn on `enable` **may not let you see the displayed equations correctly**.
72+
Firstly, you need to choose a math rendering engine and turn on `enable` for it in {% label primary@NexT config file %}. Then you need to install the **corresponding Hexo Renderer** to fully support the display of Math Equations - Only turn on `enable` **may not let you see the displayed equations correctly**.
7373

7474
{% tabs render-engines %}
7575
<!-- tab MathJax -->
7676
**Renderer Choosing**
7777

78-
If you use MathJax to render Math Equations, you can choose one of the Markdown renderers below:
79-
80-
- [hexo-renderer-pandoc](https://github.com/wzpan/hexo-renderer-pandoc)
81-
82-
hexo-renderer-pandoc is recommended because it can handle mathematical formulas in markdown documents perfectly.
78+
If you use MathJax to render Math Equations, you can choose [hexo-renderer-pandoc](https://github.com/wzpan/hexo-renderer-pandoc) as the Markdown renderer. It is recommended because it can handle mathematical formulas in markdown documents perfectly.
8379

8480
{% note warning %}
8581
If you are using other renderers, such as [hexo-renderer-marked](https://github.com/hexojs/hexo-renderer-marked), you need to be aware of the conflict between LaTeX and Markdown syntax. For example, an underscore (`_`) may be interpreted as the start of italic text in Markdown, or subscripted mark in TeX. To avoid syntax errors, please use escape characters (`\_`) instead:
@@ -92,7 +88,6 @@ If you are using other renderers, such as [hexo-renderer-marked](https://github.
9288
-\\
9389
+\\\\
9490
```
95-
9691
{% endnote %}
9792

9893
**Installation**
@@ -113,7 +108,16 @@ If you are using other renderers, such as [hexo-renderer-marked](https://github.
113108
$ npm i hexo-renderer-pandoc
114109
```
115110

116-
3. [pandoc](https://github.com/jgm/pandoc) is required for hexo-renderer-pandoc, here's [how to install pandoc](https://github.com/jgm/pandoc/blob/master/INSTALL.md).
111+
3. If you are using `hexo-renderer-pandoc` version greater than 5.0.0, you need to set `pandoc.args` in {% label info@Hexo config file %}:
112+
113+
```yml Hexo config file
114+
# config of hexo-renderer-pandoc
115+
pandoc:
116+
args:
117+
- --mathjax
118+
```
119+
120+
4. `hexo-renderer-pandoc` requires [pandoc](https://github.com/jgm/pandoc) to be installed, otherwise it will throw an error. Here's [how to install pandoc](https://github.com/jgm/pandoc/blob/master/INSTALL.md).
117121

118122
**Plugins**
119123

0 commit comments

Comments
 (0)