在前端开发的过程中，我们经常需要用到 Markdown 文本格式，比如编写文档、博客、项目说明等等。但是 Markdown 语法有些复杂，用起来不那么方便。于是，有一些前辈就推出了一些 Markdown 渲染库，可以让我们在编写 Markdown 时感到更方便快捷。其中，@zhennann/markdown 这个 npm 包就是其中一个。本文就详细介绍一下这个包的使用方法。
安装
首先，我们需要在项目中安装 @zhennann/markdown 这个包。在命令行中输入：
npm install @zhennann/markdown --save
这样就会把 @zhennann/markdown 安装到你的项目中，并且记录在 package.json 文件中。
使用
安装完成之后，我们就可以在项目中使用 @zhennann/markdown 来进行 Markdown 渲染了。在你的 js 文件中，先引入 @zhennann/markdown 包：
const markdown = require('@zhennann/markdown');之后，就可以把 Markdown 格式的字符串传入 markdown.render 函数，来得到 HTML 格式的文本了。
const html = markdown.render('# Hello world!');其他用法
除了简单的渲染 Markdown，@zhennann/markdown 还提供了其他的一些用法。比如，我们可以设置 extra 参数来扩展 Markdown 的基本语法。
const html = markdown.render('# Hello world!', {
extra: {
emoji: true,
underline: true
}
});这样，在渲染 Markdown 的时候，就会对表情符号和下划线进行解析了。
除了 extra 参数外，@zhennann/markdown 还支持设置其他的参数，详细信息可以参考包的官方文档。
示例代码
下面是一段示例代码，展示了如何使用 @zhennann/markdown 进行 Markdown 渲染。这里我们把 Markdown 格式的文本传入了函数中，并把得到的 HTML 文本展示在了 DOM 中。
-- -------------------- ---- -------
--------- -----
------
------
----- ----------------
-----------------------
-------
------
---- -------------------
------- ------------------------------------------------------------------------------------------
--------
----- ------ - -- ----- ------
---- -- - ----------
- ---- -
- ---- -
- ---- ---
----- ---- - ------------------------
-------------------------------------------- - -----
---------
-------
-------总结
@zhennann/markdown 是一个非常好用的 Markdown 渲染库，可以让我们在前端开发中更方便地处理 Markdown 格式的文本。本文介绍了其基本的使用方法和其他扩展用法，并提供了示例代码。希望这篇文章可以帮助大家更好地使用 @zhennann/markdown 包。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5f0bdfc8403f2923b035c116