dawy_go/vnote
1
0
Fork 0
mirror of https://gitee.com/vnotex/vnote.git synced 2025-07-05 13:59:52 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: update markdown_guide

Browse Source
This commit is contained in:
Le Tan 2018-07-14 13:16:20 +08:00
parent abee597812
commit 40424b7931
2 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/resources/docs/markdown_guide_en.md
View File

@ -156,11 +156,16 @@ VNote supports [Graphviz](http://www.graphviz.org/) to draw diagrams. You should
### Math Formulas
> You need to enable MathJax in the `Markdown` menu.
> You need to enable MathJax in the `Markdown` menu and restart VNote.
VNote supports math formulas via [MathJax](https://www.mathjax.org/). The default math delimiters are `$$...$$` and `\[...\]` for **displayed mathematics**, and `$...$` for **inline mathematics**. Sometimes you may need to *escape* some characters via `\`.
VNote supports math formulas via [MathJax](https://www.mathjax.org/). The default math delimiters are `$$...$$` for **displayed mathematics**, and `$...$` for **inline mathematics**.
VNote also supports displayed mathematics via fenced code block with language `mathjax` specified. The benifit of using code block is you do not have to escape most characters.
- Inline mathematics should not cross multiple lines;
- Forms like `3$abc$`, `$abc$4`, `$ abc$`, and `$abc $` will not be treated as mathematics;
- Use `\` to escape `$`;
- There should be only space chars before opening `$$` and after closing `$$`;
VNote also supports displayed mathematics via fenced code block with language `mathjax` specified.
```mathjax
$$

11
src/resources/docs/markdown_guide_zh.md
View File

@ -157,11 +157,16 @@ VNote支持 [Graphviz](http://www.graphviz.org/) 来绘制图表。您需要使
### 数学公式
> 需要在`Markdown`菜单中启用MathJax。
> 需要在`Markdown`菜单中启用MathJax，并重启VNote。
VNote通过 [MathJax](https://www.mathjax.org/) 来支持数学公式。默认的**块公式**的分隔符是`$$...$$$`和`\[...\]`，**行内公式**的分隔符是`$...$`。有时候，您需要使用`\`来*转义*某些字符。
VNote通过 [MathJax](https://www.mathjax.org/) 来支持数学公式。默认的**块公式**的分隔符是`$$...$$`，**行内公式**的分隔符是`$...$`。
VNote也可以使用标明语言`mathjax`的代码块来实现块公式。使用代码块的一个好处是大多数情况下无需转义字符。
- 行内公式不能跨多行；
- 形如`3$abc$`/`$abc$4`/`$ abc$`和`$abc $`的不会被解析为公式；
- 使用`\`转义`$`；
- 开始的`$$`之前以及结束的`$$`之后都只允许出现空格字符；
VNote也可以使用标明语言`mathjax`的代码块来实现块公式。
```mathjax
$$