npm 包 gmd-markdown-parser 使用教程

阅读时长 5 分钟读完

概述

gmd-markdown-parser 是一款 Node.js 的 npm 包,用于将 markdown 文本转换成 HTML。该包采用了 GFM (GitHub Flavored Markdown) 的语法规则,并且支持对代码块进行高亮显示。

该包使用方便,可以在 Node.js 环境下使用,也可以在浏览器端使用。同时,该包在转换时支持自定义扩展。

安装

可以通过 npm 的方式进行安装:npm install gmd-markdown-parser

如果需要在浏览器端使用该包,可以在 html 文件中引入:<script src="path/to/gmd-markdown-parser.js"></script>

使用方法

在 Node.js 环境下,可以通过以下方式使用:

在浏览器环境下,可以通过以下方式使用:

自定义扩展

在转换 markdown 文本的过程中,我们可以通过自定义扩展来增加一些额外的功能。例如,我们可以通过自定义扩展来支持在文本中插入视频或音频。

以下是自定义扩展的示例代码:

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

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

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

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

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

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

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

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

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

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

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

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

以上代码实现了在 markdown 文本中加入视频和音频功能。在文本中使用以下方式,即可触发该扩展:

总结

gmd-markdown-parser 是一款简便易用的 npm 包,可以实现 markdown 文本到 HTML 的转换,并且支持自定义扩展,非常适合前端开发人员使用。通过学习本教程,我们可以更好地掌握如何使用该包,并且掌握扩展自定义的方法。

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

纠错
反馈