GitHub 地址: https://github.com/andrewnicols/downright
简介
downright 是一个用于将 markdown 文件转换为 HTML 的 npm 包，使用简单方便，适用于前后端开发人员及 Markdown 文档编写者。下面将详细介绍如何使用 downright。
安装
npm install downright
使用
常规使用
const downright = require('downright');
// 读取 markdown 文件
const mdContent = fs.readFileSync('example.md', 'utf-8');
// 生成 HTML
const htmlContent = downright(mdContent);自定义选项
downright 支持自定义选项，用于在转换时修改一些设置。下面是一些可选的选项：
gfm：启用 GitHub 风格的 markdown，也就是说支持添加代码高亮、表情符号等。默认值为true。tables：启用表格解析，如果启用，则会将 markdown 中的表格转换为 HTML 表格。默认值为true。emoji：启用表情符号解析。默认值为false。breaks：启用换行符。默认值为false。
使用方法如下：
-- -------------------- ---- ------- ----- ------- - - ---- ----- ------- ----- ------ ------ ------- ---- -- -- -- -------- -- ----- --------- - ----------------------------- --------- -- -- ---- ----- ----------- - -------------------- ---------
示例代码
原始 markdown 文件
# 下载 你可以从 [npm](https://www.npmjs.com/package/downright) 上下载 downright： ```javascript npm install downright
代码高亮
下面是一个带有语法高亮的 JavaScript 代码块：
const downright = require('downright');
// 读取 markdown 文件
const mdContent = fs.readFileSync('example.md', 'utf-8');
// 生成 HTML
const htmlContent = downright(mdContent);表格
| 姓名 | 年龄 |
|---|---|
| 小明 | 18 |
| 小华 | 20 |
表情符号
:smile:
-- -------------------- ---- ------- --- ---- ---- -- ------- ----------- ------- -- ------------------------------------------------------ --- -------------- -------------- ------- --------- ------------- --- --------------------------------------------------- --------------- ---------- -------- ---------- --------------------------------- --------- - --------------------- -- -- -------- -- ----- --------- - ----------------------------- --------- -- -- ---- ----- ----------- - --------------------- ------------- --- ------------------------------- ------- ------- ---- ----------- ----------- ----- -------- ------- ---- ----------- ----------- ----- ---- ----------- ----------- ----- -------- -------- --- --------------------------------------------------- --------------
总结
到此，使用 downright 转换 markdown 文件为 HTML 文档的过程已经介绍完毕。虽然 downright 功能简单，但其易用性与高效性也使其成为了一款优秀的 npm 包，希望本文能够对各位前端开发人员和 Markdown 文档编写者有所启示。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005625781e8991b448df94b