npm 包 markdown-it-sub 使用教程

在前端开发中，我们经常需要使用 Markdown 语法来编写文档、README 文件等。Markdown 是一种轻量级标记语言，它可以通过简单的符号表示文本的格式和样式。而 markdown-it-sub 这个 npm 包则是用来实现下标功能的。

安装

首先我们需要安装 markdown-it-sub：

npm install markdown-it-sub

安装完成后，我们就可以在项目中使用这个包了。

使用方法

在使用 markdown-it-sub 之前，我们需要先引入这个包：

const markdownIt = require('markdown-it');
const sub = require('markdown-it-sub');

const md = markdownIt();
md.use(sub);

上面代码中创建了一个 markdownIt 实例，并将 markdown-it-sub 添加到该实例中。

接下来，我们就可以使用 ~ 符号来表示下标了。例如：

H~2~O

渲染结果为：H₂O

示例代码

下面是一个完整的示例代码：

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

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

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

在上面的示例代码中，我们使用了 markdown-it 和 markdown-it-sub 的 CDN 地址来引入这两个包。然后创建了一个 markdownIt 实例，并将 markdown-it-sub 添加到该实例中。最后，我们将渲染后的 HTML 插入到页面中。

学习意义

掌握 markdown-it-sub 的使用方法，能够让我们更加高效地编写 Markdown 文档和 README 文件。同时，也可以为我们今后开发类似下标的功能提供参考和指导。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/43342