什么是 Marky？
Marky 是一个用于将 Markdown 转换为 HTML 的工具。它支持 GitHub Flavored Markdown 和 CommonMark 标准，并提供了丰富的配置选项和自定义插件机制。Marky 还可以解析代码块中的语言，并集成了 Prism.js 来进行语法高亮。
安装和使用
你需要安装 Node.js 和 npm，然后使用以下命令来安装 Marky：
--- ------- -----
Marky 的使用非常简单，只需要调用 marky() 函数并传入 Markdown 字符串即可。例如，下面是一个简单的例子：
----- ----- - ---------------- ----- -------- - -- ------ ------- ----- ---- - --------------- -----------------
这个例子将会输出如下的 HTML：
---------- -----------
配置选项
Marky 提供了一些配置选项，可以让你更好地控制转换过程。你可以通过传递一个可选的配置对象来设置这些选项。下面是一些常用的选项：
sanitize: 是否启用 HTML 标签过滤，默认为true。highlightSyntax: 是否启用语法高亮，默认为true。package: 在package.json文件中查找的配置信息。plugins: 自定义插件列表，每个插件都是一个函数，接受一个markdown-it实例作为参数。
例如，下面是一个使用自定义插件的例子：
----- ----- - ---------------- ----- -------- - ---------------------- ----- -------- - -- ------ ------- ----- ---- - --------------- - -------- ---------- -- -----------------
自定义插件
Marky 使用了 markdown-it 库来进行 Markdown 解析。你可以通过编写自己的插件来扩展或修改 Marky 的解析过程。
下面是一个简单的自定义插件，它将所有图片的 alt 属性设置为图片文件名：
-------------- - -------------------- -
------------------------------- - ---------------- ---- -------- ---- ----- -
----- ----- - -----------
----- --- - --------------------------------------
----- --- - --------------------
----------------------------------- - ------- ----
------ ------------------------ ---- --------
-
-你可以将这个插件传递给 Marky 的配置选项中来启用它：
----- ----- - ---------------- ----- -------- - ---------------------- ----- -------- - ---------- --------------------------- ----- ---- - --------------- - -------- ---------- -- -----------------
这会将 Markdown 中的图片转换为以下 HTML 代码：
------- ------------------------ --------------------
总结
本文介绍了如何使用 npm 包 Marky 将 Markdown 转换为 HTML。我们还讨论了一些配置选项和自定义插件的用法，希望这对你有所帮助。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/44971