在前端开发中，markdown 在文档展示上有着广泛的应用。使用 Docpad-plugin-marked 这个 NPM 包，我们可以非常方便地将 markdown 转换为 HTML 并展示在网页上。本文将详细介绍该 NPM 包的使用方法和相关知识。
使用前须知
在使用 Docpad-plugin-marked 之前，我们需要了解以下几个知识点：
Node.js
Docpad-plugin-marked 是一个 Node.js 模块，因此需要安装 Node.js 环境。安装方法可以参考官方文档。
NPM
NPM（Node Package Manager）是 Node.js 的包管理器，需要使用 NPM 来安装 Docpad-plugin-marked。
Docpad
Docpad 是一个静态网站生成器，可以让我们使用模板和插件来快速构建静态网站。Docpad-plugin-marked 就是一个可以通过 Docpad 使用的插件。
安装 Docpad-plugin-marked
使用 NPM 安装 Docpad-plugin-marked，只需要在终端中输入以下命令：
npm install docpad-plugin-marked --save
其中，--save 参数意味着将该包安装到项目中，并在 package.json 文件中添加该包的依赖项。
使用 Docpad-plugin-marked
安装 Docpad-plugin-marked 后，我们就可以在 Docpad 中使用它来渲染 markdown 文件。以下是具体的使用方法：
配置
我们需要在 docpad.js 配置文件中添加 Docpad-plugin-marked：
plugins: {
marked: {}
}文件格式
我们需要在 markdown 文件的头部添加 Front-matter，并指定当前文件的格式：
--- layout: post title: Hello, World! format: markdown ---
注意，上述的格式可能因为你的网站布局不同而有所不同。
渲染
在文档页面中使用 EJS 等模板语言时，我们可以使用 <%- content %> 来展示渲染后的 markdown 内容。
示例代码
以下是一个完整的例子，使用 Docpad-plugin-marked 渲染 markdown 文件并展示在网页上：
-- -------------------- ---- -------
-- ---------
-------------- - -
-------- -
------- --
-
-
-- -------------
------
------
---------- -------------- ----------
-------
------
------- -------------- -------
-------- ------- --------
-------
-------
-- --------------
---
------- ----
------ ------ ------
------- --------
---
- ------ ------
---- -- -- ----- ---- -----结语
我们通过本文的介绍，了解了如何使用 Docpad-plugin-marked，将 markdown 转换为 HTML 并展示在网页上。同时，我们还学习了 Node.js、NPM 和 Docpad 等相关知识。希望本文对你有指导意义，如果有问题欢迎交流！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/61851