前言
metalsmith 是一个 JavaScript 静态网站生成器,通过使用插件,可以实现各种不同的功能,例如处理 Markdown、Sass、压缩 HTML 和图片等。metalsmith-raw 是其中一个比较有用的插件,它能够直接读取文件的原始内容,并将其传递给插件链中的下一个插件。本文将详细介绍 metalsmith-raw 的使用方法和示例。
安装
通过 npm 即可安装 metalsmith 和 metalsmith-raw。
npm install metalsmith metalsmith-raw
使用
在使用 metalsmith-raw 插件时,需要在 metalsmith 中注册该插件。
const metalsmith = require('metalsmith'); const raw = require('metalsmith-raw'); metalsmith(__dirname) .use(raw()) .build(err => console.log(err || 'Build complete'));
注册插件后,metalsmith 将会针对每一个文件执行插件。如果文件的后缀名在 metalsmith 插件链中已注册,则会使用注册的插件对该文件进行处理;否则,metalsmith-raw 将直接读取该文件的原始内容,并继续将其传递给下一个插件或者完成文件的构建。
在这种情况下,metalsmith-raw 只是起到了一个中间件的作用,它不会对文件内容进行任何的处理,同样也不会修改文件的后缀名和文件名等。
示例代码
下面是一个简单的示例,假设有一个名为 index.md
的文件,其中包含有 HTML 代码。
-- -------------------- ---- ------- --------- ----- ----- ---------- ------ ----- ---------------- ----------------------- ------- ------ --------- ----------- ------- -------
现在我们可以在 metalsmith 中引入该文件,然后在 metalsmith-raw 插件中打印出该文件的原始内容。
-- -------------------- ---- ------- ----- ---------- - ---------------------- ----- --- - -------------------------- --------------------- ------------ ----------- --------------------- ------------ ------ -- - -- ----- ----- ---- --------------------------------------------------- ---
执行该代码后,可以在终端中看到文件 index.md
的原始内容。
-- -------------------- ---- ------- - ---- -------- --------- ----- ----- ---------- ------ ----- ---------------- ----------------------- ------- ------ --------- ----------- ------- -------
总结
metalsmith-raw 是一个非常实用的插件,它可以让我们在 metalsmith 构建过程中直接读取文件的原始内容,并将其传递给下一个插件进行处理。在开发静态网站时,如果碰到一些特殊文件需要特殊处理时,metalsmith-raw 就能为我们提供帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066f411d8e776d08040d18