Metalsmith是一个静态站点生成器，可以用于构建博客、文档、网站等静态站点。metalsmith-md是一个Metalsmith插件，用于将Markdown文件转换为HTML文件并添加到Metalsmith的构建流程中。
安装
在使用metalsmith-md之前需要先安装Node.js和Metalsmith。然后可以通过以下命令安装metalsmith-md:
npm install metalsmith-md --save-dev
使用方法
- 在Metalsmith项目中引入metalsmith-md插件：
const metalsmith = require('metalsmith');
const markdown = require('metalsmith-md');
metalsmith(__dirname)
.use(markdown())
.build();- 添加Markdown文件：
在Metalsmith项目的源文件夹中添加Markdown文件，metalsmith-md会将这些文件转换成HTML文件，并添加到Metalsmith的构建流程中。
例如，在source目录下创建一个hello.md文件，内容如下：
# Hello, World! 这是我的第一篇文章。
- 配置metalsmith-md插件：
默认情况下，metalsmith-md插件将Markdown文件转换成HTML文件，并将其存储在同一目录下，名称与原始文件相同，只是扩展名改为.html。
如果需要对转换过程进行更多的配置，可以传递一个选项对象给插件：
metalsmith(__dirname)
.use(markdown({
gfm: true,
tables: true
}))
.build();上面的选项对象启用了Github风格的Markdown和表格支持。
示例代码
下面是一个完整的Metalsmith项目示例，包括metalsmith-md插件和配置选项：
-- -------------------- ---- -------
----- ---------- - ----------------------
----- -------- - -------------------------
---------------------
-----------
------ --- -----
--
----------------
-----------------------
------------
---------------
---- -----
------- ----
---
-------------------- -
-- ----- -
----- ----
-
------------------ ------------
---在此示例中，./src目录包含Markdown文件，这些文件将被转换成HTML文件并存储在./build目录中。选项metadata设置了一个全局变量，可以在模板中使用。
总结
通过使用metalsmith-md插件，我们可以轻松地将Markdown文档转换为静态网站，并且可以方便地对转换过程进行多种配置。但是，需要注意的是，Metalsmith需要一些学习曲线，需要对其基本概念和工作原理有一定的了解才能更好地使用它。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/47768