1. 介绍
node-markdown 是一款使用 Node.js 编写的将 Markdown 转换为 HTML 的 npm 包，可以用于前端开发中将 Markdown 文档转换为网页展示。
2. 安装
运行以下命令可以全局安装 node-markdown：
--- ------- -- -------------
3. 使用方法
3.1 命令行使用
安装完成之后，我们可以在命令行中使用 node-markdown：
-------- ---------
将 README.md 转换为 HTML。
我们还可以使用 -f 参数指定输出文件，例如：
-------- -- ----------- ---------
这会将 README.md 转换为 HTML，并且输出到 README.html 文件中。
3.2 模块使用
我们也可以通过 require 引入 node-markdown，使用其中的函数进行转换。例如：
----- -------- - ------------------------ ----- -- - ------------- ----- -- - ---------------------------- -------- ----- ---- - ------------ ------------------------------- -----
这个例子中，我们使用 fs 将 README.md 读取为一个字符串，然后使用 markdown 函数将其转换为 HTML，最后使用 fs 将 HTML 写入到 README.html 文件中。
4. 配置选项
node-markdown 还提供了一些配置选项，可以用于定制转换过程。下面介绍其中一些常用选项：
4.1 gfm
默认情况下，node-markdown 不支持 GitHub Flavored Markdown（简称 GFM）。如果需要使用 GFM，需要将 gfm 选项设置为 true：
------------ - ---- ---- --
4.2 breaks
默认情况下，node-markdown 不会将换行符转换为 <br>。如果需要将换行符转换为 <br>，需要将 breaks 选项设置为 true：
------------ - ------- ---- --
4.3 tables
默认情况下，node-markdown 不会将表格转换为 HTML。如果需要将表格转换为 HTML，需要将 tables 选项设置为 true：
------------ - ------- ---- --
5. 总结
node-markdown 是一款非常方便的 Markdown 转换工具，可以帮助我们将 Markdown 文档转换为 HTML。它提供了丰富的配置选项，可以满足我们不同的转换需求。我们可以通过命令行或者在代码中使用它，非常方便。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/75623