npm 包 snarkdown 使用教程

阅读时长 3 分钟读完

简介

snarkdown 是一个用于将 markdown 转换为 HTML 的 JavaScript 库,它适用于前端环境。

snarkdown 的特点在于它使用了微小但非常强大的代码量。相比其他的 markdown 转换库,snarkdown 十分轻量级,只有 127 行。

安装

使用 npm 安装 snarkdown:

使用

snarkdown 的使用非常简便。只需传入一个 markdown 字符串,它就会返回相应的 HTML 字符串。

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

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

---

-- ---

---
--

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

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

输出结果:

更多用法

snarkdown 还支持更多的 markdown 语法,比如:

代码块

表格

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

对于 HTML 的转义

如果想要将 HTML 语言以及特定字符转义而非转换为 HTML 代码,可以传入第二个参数 true

输出结果:

结论

snarkdown 是一款小巧但功能强大的 markdown 转换库。它可以轻松地将 markdown 转换为 HTML,同时支持更多的 markdown 语法。如果您正在寻找一款简易但高效的 markdown 转换库,那么 snarkdown 绝对是您的不二之选。

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

纠错
反馈