npm 包 mdium 使用教程

阅读时长 3 分钟读完

什么是 mdium

mdium 是一个用于在 Markdown 中渲染数学公式的 npm 包,它使用 KaTeX 渲染引擎进行渲染,并支持能够在 Markdown 中插入的大多数 LaTeX 命令。

安装

安装 mdium 包非常简单,只需要在 cmd 或终端中输入以下指令即可:

使用

在需要在页面中展示渲染公式的地方,我们可以使用 mdium(string) 函数,它接受一个字符串类型的 Markdown,返回一个包含渲染后公式的字符串。

下面是一个使用 mdium 渲染公式的示例:

  1. 使用 node.js 编写一段脚本,命名为 test.js
-- -------------------- ---- -------
----- ----- - -----------------

----- -------- - ----- -------- ---------- ----- ---

----------------- - - -------------------

---- ------------

----- -------- - ----------------

----------------------
  1. 打开命令行或终端,切换到项目根目录下,执行以下命令:

控制台将输出以下结果:

其中 <div> 标签和 <p> 标签是 mdium 渲染的公式包裹的 HTML 标签。

支持的命令

mdium 支持几乎所有在 LaTeX 中使用的命令,这里列出一些较为常用的命令:

  • $$ 直接插入 LaTeX 公式
  • $ 将 LaTeX 公式嵌入到文本中
  • \\frac{a}{b} 向上分数线
  • \\sqrt[a]{b} 方根符号
  • \\vec{a} 向量符号
  • \\sum 累加符号
  • \\prod 累乘符号
  • \\int 积分符号

更多命令可以查看 KaTeX 官方文档。

注意事项

由于 KaTeX 渲染引擎是在客户端上渲染公式的,因此 mdium 只适用于在浏览器端和 Electron 之类的客户端应用程序中使用,并不适用于 Node.js 端的渲染。

结语

mdium 是一个非常方便且易于使用的 npm 包,它为我们在 Markdown 中渲染数学公式带来了非常大的便利性。在项目中,只需要简单地导入这个包,就可以很容易地展示对美观而又详尽的数学公式了。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600671d730d0927023822e3a

纠错
反馈