在前端开发中，我们经常需要编写文档或者博客，而选择一个好的 markdown 工具则可以给我们节省很多时间和日常工作的麻烦。本文将会介绍一款非常好用的 npm 包，wukong-markdown，它不仅具有简单易上手的特点，同时也可以满足大部分编写 markdown 文章的需求。
wukong-markdown 是什么？
wukong-markdown是一款基于 markdown-it 的软件包，可以用于将markdown转换为HTML。 它内置了兼容 GitHub 和其他一些流行的 markdown 语法，并提供了大量的选项和插件，可以轻松地自定义您的markdown文档。
安装
可以通过以下命令来安装 wukong-markdown:
npm install -S wukong-markdown
使用方法
基本使用方式
-- -------------------- ---- ------- ------ -------------- ---- ----------------- ----- ------------ - -- ----- ----- ------------- ----- -------- - ---------------------------- --------------------- -- --------- -----------------------------
上述代码演示了 wukong-markdown 最基本的使用方式，只需要将 markdown 文本传入 WukongMarkdown 方法中即可将其转换为 HTML。在实际项目中，我们还可以添加更多的参数来满足我们的需求。
扩展支持的语法
wukong-markdown 内置了许多不同的插件和扩展，你可以使用其中的一些或自己编写一个。
- anchor(
anchor:enable=false)
用来为markdown标题生成锚点链接
const htmlText = WukongMarkdown(markdownText, {
anchor: {
enable: true
}
})- emoji(
emoji:enable=false)
支持使用emoji表情的插件
const htmlText = WukongMarkdown(markdownText, {
emoji: {
enable: true
}
})- katex(
katex:enable=false)
支持数学公式的插件
const htmlText = WukongMarkdown(markdownText, {
katex: {
enable: true
}
})自定义插件
如果您的需求无法通过内置插件来实现，您可以为其编写自己的插件。
-- -------------------- ---- -------
------ ---------- ---- -------------
----- ------------ -
-------------------- -
------------ - -------
-
----- ---- -
--------------------------------- ---------------- ------- ------- -- -
-- ---- ---- ----
--
-
-
----- -- - --- ------------
---------- --------------
------- -----
-------- --
---
----- -------- - ----------------------上述代码展示了如何编写一个自定义插件并将其添加到 markdown-it 中。通过 constructor 中传入的 options，你可以对插件进行各种自定义设置，这使得你可以更灵活地使用和定制 wukong-markdown。
总结
wukong-markdown 是一款非常好用的 npm 包，支持大多数的 markdown 语法，并且可通过自定义插件来满足更多的需求。在编写 markdown 文档时，它将为我们节省很多时间和麻烦。希望这篇文章对于初学者能有一些帮助，也希望更多的开发者能够使用和贡献 wukong-markdown。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6006711a8dd3466f61ffe806