npm 包 markdown-it-katex-external 使用教程

阅读时长 11 分钟读完

Markdown 是一种轻量级的标记语言,可用于快速编写结构化的文档,并且使用广泛。而 markdown-it-katex-external 则是一款支持 LaTeX 数学公式渲染的 npm 包。本文将介绍如何使用这个包。

安装

使用

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

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

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

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

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

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

上面代码中,首先引入 markdown-itmarkdown-it-katex-external 包,并使用 use 方法加载 markdown-it-katex-external。然后,在 markdown 字符串中,使用 $ 包裹 LaTeX 数学公式。在代码块中用 math 语法。最后,使用 md.render 方法将 markdown 渲染成 HTML。

参数

markdown-it-katex-external 的参数包括:

  • throwOnError: 默认为 true,当 LaTeX 公式出现错误时,抛出异常。设置为 false 后,只在输出的 HTML 中标记错误,但不抛出异常。
  • errorColor: 当 throwOnErrorfalse 时,指定错误标记颜色。默认为 #cc0000
  • macros: 自定义 LaTeX 宏。

示例

在 markdown 中插入 LaTeX 公式,并输出渲染后的 HTML。

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

-- ----- ---

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

-- ----- ---

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

---

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

渲染结果如下:

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

总结

markdown-it-katex-external 包可以在 markdown 文档中方便地使用 LaTeX 公式,并以 HTML 形式呈现。使用该包需要先安装 markdown-itmarkdown-it-katex-external 包,使用 use 方法加载 markdown-it-katex-external 插件。然后,在 markdown 中使用 $ 包裹 LaTeX 数学公式,用 math 语法插入代码块即可。同时,该插件还提供了参数设置和自定义 LaTeX 宏的功能,方便扩展使用。

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

纠错
反馈