Skip to content

@sciexpr/markdown

markdown-it 公式插件。

安装

bash
npm install @sciexpr/markdown markdown-it

用法

typescript
import MarkdownIt from 'markdown-it'
import { formulaPlugin } from '@sciexpr/markdown'

const md = new MarkdownIt().use(formulaPlugin)

md.render('E = $mc^2$')          // 行内公式
md.render('$$\n\\sum n\n$$')     // 块级公式

化学式

typescript
md.use(formulaPlugin, { enableChemistry: true })
md.render('\\ce{H2O}')

配置

typescript
md.use(formulaPlugin, {
  enableChemistry: true,       // 化学式自动识别
  enableNumbering: true,       // 公式编号
  inlineDelimiter: '$',        // 行内分隔符
  blockDelimiter: '$$',        // 块级分隔符
})

输出 HTML

html
<span class="sciexpr-formula sciexpr-inline" data-formula="E=mc^2">E=mc^2</span>
<div class="sciexpr-formula sciexpr-block" data-formula="\frac{1}{2}">\frac{1}{2}</div>

使用 data-formula 属性,前端可进一步用 KaTeX 客户端渲染。

基于 MIT 协议发布