背景
在前端开发中，我们经常需要编辑和维护 markdown 格式的文档。而 broccoli-md 是一款 npm 包，可以将 markdown 文件编译成网页，非常方便。
安装
在使用前，我们需要通过 npm 安装 broccoli-md：
npm install broccoli-md --save-dev
使用
broccoli-md 的使用非常简单，只需要在项目根目录下的 Brocfile.js 文件中加入以下代码：
var markdown = require('broccoli-md');
var tree = 'path/to/markdown/folder';
module.exports = markdown(tree);其中，tree 是 markdown 文件所在的目录，可以是相对路径或绝对路径。
配置
如果需要对编译后的页面进行进一步的配置，我们可以在 Brocfile.js 中设置 options，例如：
-- -------------------- ---- ------- --- -------- - ----------------------- --- ---- - -------------------------- --- ------- - - ------ --- -------- ------ ------ ---------- ---- ------------- ----- ----- ---- ---- -- -------------- - -------------- ---------
其中，各个选项的含义如下：
title：页面的标题（默认为 Markdown 文件的名称）；theme：页面的主题（目前只有一个预设主题 "default"）；css：自定义页面的 CSS 样式表；hljs：是否使用 Highlight.js 高亮代码；bs4：是否使用 Bootstrap 4 样式。
示例
下面是一个完整的示例，在一个名为 "markdown" 的文件夹下有两个 markdown 文件：hello.md 和 world.md，它们的内容分别如下：
hello.md
# Hello, World! This is my first markdown page.
world.md
# Welcome to the World! This is another markdown page.
我们可以在项目根目录的 Brocfile.js 中添加以下代码：
-- -------------------- ---- ------- --- -------- - ----------------------- --- ---- - ----------- --- ------- - - ------ --- -------- --------- ------ ---------- ---- ------------- ----- ----- ---- ---- -- -------------- - -------------- ---------
然后在命令行中运行 broccoli serve，就可以在浏览器中查看生成的页面了。
总结
通过使用 broccoli-md 这个 npm 包，我们可以非常方便地将 markdown 文件编译成网页，而且可以进行细致的配置，适配不同的需求。这一技术在前端开发中具有广泛的应用，对于文档编写、博客搭建等场景都非常有用。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066c87ccdc64669dde502f