pagedown 是一个基于 JavaScript 的 Markdown 渲染引擎。它可以将 Markdown 格式的文本转换为 HTML,支持代码高亮、表格、列表等常见 Markdown 语法。
在本篇文章中,我们将学习如何使用 pagedown 来渲染 Markdown 文本,并且展示一些实用的示例代码。
安装
你可以通过 npm
安装 pagedown:
--- ------- --------
如果你想在浏览器中使用 pagedown,可以直接下载 pagedown.js 或者 pagedown.min.js 文件并引入到你的页面中。
使用
在 Node.js 中,你可以通过以下方式来渲染 Markdown 文本:
----- -------- - -------------------- ----- --------- - --- --------------------- ----- ------------ - ----- ------------ ---- ----- ---- - --------------------------------- ------------------ -- -------- ------------------------- -------
在浏览器中,你可以像下面这样来使用 pagedown:
--------- ----- ------ ------ ----- ---------------- --------------- ---------- ------- ----------------------------------- ------- ------ ---- -------------------- -------- ----- --------- - --- --------------------- ----- ------------ - ----- ------------ ---- ----- ---- - --------------------------------- --------------------------------------------- - ----- --------- ------- -------
示例
代码高亮
pagedown 支持通过 highlight.js 实现代码高亮功能。你需要先在页面中引入 highlight.js:
----- ---------------- ----------------------------------------------------------------------------------- ------- -------------------------------------------------------------------------------------
然后在使用 pagedown 的时候,将 highlight.js 的相关选项传递给 Converter 构造函数即可:
----- ------- - - ----------- -------------------- ---------- -------- ------ ----- - ------ ------------------------ -------------- - -- ----- --------- - --- ---------------------------- ----- ------------ - ----------------------------------- ---------------- ----- ---- - --------------------------------- ------------------ -- ----------- ----------- -------------------------- --------------------------------------- --------------
表格
要创建表格,只需使用 Markdown 的标准语法即可:
- -- - -- - - --- - --- - - ---- - ------ - - --- - ------ -
输出的 HTML 将会是这样的:
------- ------- ---- ----------- ----------- ----- -------- ------- ---- ------------- --------------- ----- ---- ------------ --------------- ----- -------- --------
列表
pagedown 支持多种类型的列表,包括无序列表和有序列表。你可以使用 Markdown 的标准语法来创建它们:
- ----- - - ----- - - ----- - -- ----- - -- ----- - -- ----- -
输出的 HTML 将会是这样的:
---- --------- ------ --------- ------ --------- ------ ----------------------------------------------------------- ---------- ---------------------------------------------------------------------------------------