Skip to content

在 markdown-it 中支持 TEX 数学公式,避免数学公式的某部分被解析为 markdown。

License

Notifications You must be signed in to change notification settings

llingy/markdown-it-tex-equations

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

markdown-it-tex-equations

在 markdown-it 中支持 TEX 数学公式,避免数学公式的某部分被解析为 markdown。

参考 markdown-it-katex 以及 markdown-it-mathjax3 的代码实现。

快速开始

  1. 安装 markdown-it 和这个插件

    npm install markdown-it markdown-it-tex-equations
  2. 在你的代码中使用

    var md = require('markdown-it')(),
        math = require('markdown-it-tex-equations');
    
    md.use(math);
    
    // double backslash is required for javascript strings, but not html input
    var result = md.render('# Math Rulez! \n  $\\sqrt{3x-1}+(1+x)^2$');

自定义

支持在代码块中插入 \displaylines{} 以让 Mathjax 3 支持公式换行。

md.use(math,{inline:false,block:true});

以上为默认值,inline 表示内联公式是否开启,block 表示多行公式是否开启,如果使用 Mathjax 2 或者 Katex,请传入 {inline:false,block:false}

About

在 markdown-it 中支持 TEX 数学公式,避免数学公式的某部分被解析为 markdown。

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published