在前端开发中，书写 Markdown 是一个常见的任务。而 re-markeng 是一个很好的 npm 包，可以帮助我们快速地将 Markdown 源码解析为 HTML。在本文中，我将会详细介绍如何使用 re-markeng 这个工具。
安装和引入 re-markeng
首先，我们需要安装 re-markeng：
npm install re-markeng
之后，我们需要在代码中引入 re-markeng：
const reMarkEng = require('re-markeng')快速入门
下面是使用 re-markeng 的基本示例。我们可以将下面的代码保存为 demo.js 文件，然后在命令行中执行 node demo.js 来运行代码：
const reMarkEng = require('re-markeng')
const input = '# Hello world!\n\nThis is a _simple_ markdown document.'
const output = reMarkEng.toHTML(input)
console.log(output)这段代码使用了 re-markeng 来将 Markdown 文档转换为 HTML 返回给 output 变量。然后我们使用 console.log 来输出转换后的 HTML 的内容。运行这个程序，我们会看到下面的输出：
<h1>Hello world!</h1> <p>This is a <em>simple</em> markdown document.</p>
支持的选项
在使用 re-markeng 时，我们可以通过传递选项对象来定制解析 Markdown 的行为。下面是一些常用的选项：
gfm：启用 GitHub 风格的 Markdown 扩展。sanitize：删除所有 HTML 标签。xhtmlOut：使用 XHTML 语法输出 HTML。
我们可以将这些选项在解析 Markdown 的时候传入 re-markeng。示例如下：
-- -------------------- ---- ------- ----- --------- - --------------------- ----- ----- - -- ------ ------ ------------------------------------ ----- ------ - ----------------------- - ---- ----- --------- ----- --------- ----- -- -------------------
这段代码将会创建一个包含 <script> 标签的 Markdown 文档。在解析的时候，我们使用了 sanitize 选项来删除所有 HTML 标签从而避免 XSS 攻击。
定制渲染器
在 re-markeng 中，我们可以使用渲染器来控制解析后的 HTML 视图的显示，并且支持自定义标签和属性，从而可以定制更加符合需求的解析器。我们可以通过调用 reMarkEng.renderer() 方法来自定义一个渲染器。
下面是一个简单的例子，自定义一个渲染器来将所有的文本颜色设置为红色：
-- -------------------- ---- ------- ----- --------- - --------------------- ----- ----- - -- ------ ------- ----- -------- - -------------------- ------------------ - ------ -- - ------ --- ------------- ------------------ - ----- ------ - ----------------------- - -------- -- -------------------
这段代码中，我们首先调用 reMarkEng.renderer() 方法来创建一个渲染器。之后，我们重写渲染器的 paragraph 方法，将渲染后的 HTML 元素 text 标签颜色设置为了红色。最后，我们调用 toHTML 方法并将渲染器作为选项传递进去，将解析出来的 HTML 输出到控制台。
总结
在本文中，我们介绍了 npm 包 re-markeng 的使用，包括了安装、引入、快速入门、支持的选项和定制渲染器。希望这篇文章能够帮助你更好地理解 re-markeng 包的使用方式，以及在前端开发中如何高效地处理 Markdown。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/74966