前言
Metalsmith 是一个现代的静态网站生成器，它可以很方便的将 Markdown 文件转化成 HTML 文件，然后生成静态网站。Metalsmith-Paths 则是 Metalsmith 的一个插件，它可以重写文件路径并且可以选择过滤哪些文件需要重写。
在这篇文章中，我们将详细介绍如何使用 Metalsmith-Paths 插件，并且附带实例代码和一些指导意义。
安装 Metalsmith-Paths
在使用 Metalsmith-Paths 插件之前，需要先安装 Metalsmith 和 Metalsmith-Paths。可以使用 npm 进行安装：
npm install --save-dev metalsmith npm install --save-dev metalsmith-paths
使用 Metalsmith-Paths
在 Metalsmith 中使用 Metalsmith-Paths，需要使用 Node.js 的 require() 方法将其导入，然后将其作为 Metalsmith 插件的一个参数进行传递。
在使用 Metalsmith-Paths 进行重写路径之前，需要先将处理 Markdown 文件的 Metalsmith 插件进行配置。请看下面的代码：
const metalsmith = require('metalsmith'); const markdown = require('metalsmith-markdown'); metalsmith(__dirname) .source('./src') .destination('./build') .use(markdown()) .use(paths());
上述代码中，我们首先导入了必要的依赖，然后创建了一个 Metalsmith 实例。接下来，我们使用 source() 方法指定了源文件的目录，使用 destination() 方法指定了生成文件的目录。然后，我们使用 use() 方法加载了 metalsmith-markdown 插件和 metalsmith-paths 插件，其中 .use(paths()) 表示我们要使用 Metalsmith-Paths 插件。
Metalsmith-Paths 的配置
在使用 Metalsmith-Paths 进行重写路径之前，需要配置一些参数和规则。
下面是一个示例代码，它展示了如何配置 Metalsmith-Paths：
-- -------------------- ---- ------- ----- ----- - ---------------------------- --------------------- ---------------- ----------------------- ---------------- ------------ --------- ------- --------------- ----- ---------- -------- ------ ---------- ------- ------------------- ----展开代码
上述代码中，我们已经添加了 metalsmith-paths 插件，并传递了一些配置选项。
下面是配置的每个选项：
property: 生成的文件名属性；如果设置为path，那么生成的文件名将会是输入文件的完整路径，不包含扩展名；默认为slug。directoryIndex: 指定是否为目录生成目录索引文件，默认为true。extension: 生成文件的扩展名，默认为.html。match: 需要重写的文件路径，默认为**/*。ignore: 忽略的文件路径模式，默认为[]。
示例代码
下面是一个示例代码，它展示了如何使用 Metalsmith 和 Metalsmith-Paths 生成 HTML 文件：
-- -------------------- ---- ------- ----- ---------- - ---------------------- ----- -------- - ------------------------------- ----- ----- - ---------------------------- ----- -------- - --------------------------- ----- ------- - ------------------------------ --------------------- ---------------- ----------------------- ------------ ---------------- ------------- -------------- ------- --------- ---------- ------------ -------- --------------- -------- ----------- --- ------------ -- - -- ----- ----- ---- ------------------ ------------ ---展开代码
上述代码中，我们使用了 Markdown 插件、Paths 插件和 Layouts 插件。Paths 插件用于重写文件路径，Layouts 插件用于渲染 HTML 模板。
结论
Metalsmith-Paths 是一个实用的 Metalsmith 插件，它可以帮助我们轻松地对文件路径进行重写，并且可以过滤不需要处理的文件。希望这篇文章对你有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/158149
