随着前端框架和技术不断更新，现在无论是在开发过程中还是学习阅读文档时，markdown 都是不可缺少的一种文档格式。但是，markdown 的语法格式还是比较难记忆并不友好，因此，npm 包 rmarked 应运而生。它可以方便地将 markdown 文本转换成 html 展示，本文将为大家提供 rmarked 的使用教程。
Step 1：安装 rmarked
要使用 rmarked，首先得要在你的项目中安装它。打开终端，进入你的项目目录，使用以下命令安装 rmarked：
npm install rmarked
安装完成后，你就可以在你的项目中使用 rmarked 了。
Step 2：使用 rmarked 将 markdown 转换成 html
在你的项目中，你需要使用 JavaScript 代码将 markdown 文本转换成 html 文本。以下是一个示例代码：
const rmarked = require('rmarked');
const markdown = '这是一段 markdown 文本';
const html = rmarked(markdown);
console.log(html);在这个示例代码中，我们首先引入了 rmarked，然后定义了一个 markdown 变量来存储 markdown 文本。然后使用 rmarked(markdown) 命令将 markdown 文本转换成相应的 html 文本，将结果赋给了 html 变量，最后在控制台输出了 html 变量的值。
Step 3：更多 rmarked 的使用技巧
1. 自定义渲染器
如果你想要自定义渲染器，可以使用以下代码：
-- -------------------- ---- ------- ----- ------- - ------------------- ----- -------- - --- ------------------- ---------------- - ------ ------ -- - ------ --------------------------------- -- ----- -------- - ------------------------------- ----- ---- - ----------------- - --------- -------- --- ------------------
在这个示例代码中，我们定义了一个 renderer 变量，用于存储自定义的渲染器，然后我们修改了自定义渲染器的 heading 属性，返回的值是对应的 html 标签。注意这里在转换时需要传入自定义渲染器。
2. 设置选项
在使用 rmarkdown 时，你可以设置一些选项来控制转换的行为。以下是一些常用的选项：
- gfm：启用 GitHub 风格的 markdown。
- breaks：启用回车换行。
- pedantic：更加严格的 markdown 解析模式。
示例代码：
-- -------------------- ---- ------- ----- ------- - ------------------- ----- ------ - - ---- ----- ------- ----- --------- ----- -- ----- -------- - ----- ------------ ---- ----- ---- - ----------------- -------- ------------------
在示例代码中，我们定义了一个 option 变量，用于存储选项，然后在进行转换时将这些选项作为第二个参数传入。
结论
至此，我们已经了解了如何使用 rmarked 将 markdown 文本转换成相应的 html 文本。无论是在开发过程中还是学习阅读文档时，rmarked 简化了 markdown 的语法格式，让我们更加专注于编写内容，提高了工作效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005664b81e8991b448e2669