前言
在前端开发的过程中，经常会使用到静态网站生成器，例如：Jekyll、Hexo 等等。静态网站生成器的核心思想就是将一些已有的文本文件（通常是 Markdown 格式的文件）渲染成网页。为了让渲染更加高效，通常我们会使用一些工具来帮助我们处理文本文件，例如：将 Markdown 文件转换成 HTML 文件、提取文件中的元数据等等。而本篇文章所介绍的 metalsmith-frontmatter 就是这样一个工具。
metalsmith-frontmatter 简介
metalsmith-frontmatter 是一个适用于静态网站生成器 Metalsmith 的插件，它可以帮助我们提取文本文件中的元数据。其中，元数据可以理解为文件的一些描述信息，例如：文件的创建时间、作者、标签等等。
使用 metalsmith-frontmatter，我们可以在处理文本文件之前，将文件中的元数据提取出来，并存储在文件的 metadata 属性中。随后，我们就可以在其他插件中使用这些元数据了。例如：我们可以使用 metalsmith-markdown 插件将 Markdown 文件转换成 HTML 文件，并使用文件的 metadata 属性中存储的一些元数据来生成页面的一些描述信息。
metalsmith-frontmatter 使用教程
安装
我们可以使用 npm 包管理器来安装 metalsmith-frontmatter 插件，命令如下：
npm install metalsmith-frontmatter --save
配置
在使用 metalsmith-frontmatter 插件之前，我们需要在 Metalsmith 中注册该插件。注册的方式通常为在 Metalsmith 的配置文件中配置 plugins 属性。具体来说，我们需要在 plugins 数组中添加一个对象，该对象包括了插件的名称和配置信息。
const metalsmith = require('metalsmith');
const frontmatter = require('metalsmith-frontmatter');
const smith = metalsmith(__dirname)
.use(frontmatter()); // 注册插件在上面的代码中，我们通过 require 函数引入了 metalsmith-frontmatter 模块，并将其注册在了 Metalsmith 中。配置信息为空时，插件会使用默认的配置信息进行处理。
使用
使用 metalsmith-frontmatter 插件非常简单，只需要在每个文本文件的头部添加 YAML 形式的元数据就可以了。例如，对于一个示例文件 post.md，我们可以这样编写：
-- -------------------- ---- ------- --- ------ ----- ----------------------- ----- ------------ --------- ------ ----- - ---------- - ----------- --- - ---- ---------------------- --------- -----------------------
在上面的示例中，我们使用了 YAML 的形式来存储了该文件的元数据。在该文件被处理之后，元数据会被解析并存储在文件的 metadata 属性中，例如：我们可以通过 file.metadata.title 访问文件的 title 属性。
示例代码
下面是一个完整的 metalsmith-frontmatter 使用示例：
-- -------------------- ---- ------- ----- ---------- - ---------------------- ----- ----------- - ---------------------------------- ----- -------- - ------------------------------- ----- ----- - --------------------- ------------------- -- ---- ----------------- -- -- ------------------- -- ------------------------- ------ - -- ----- ----- ---- ------------------- ---
上面的示例中，我们将 metalsmith-frontmatter 和 metalsmith-markdown 两个插件都注册到了 Metalsmith 中，并使用 build 方法来处理文本文件。在 Metalsmith 处理完所有文件之后，我们可以在回调函数中获取到所有处理后的文件列表。
总结
本文介绍了如何使用 npm 包 metalsmith-frontmatter 来提取文本文件中的元数据。我们首先简要介绍了该插件的作用和原理，随后详细介绍了该插件的安装、配置和使用方法。最后，我们给出了一个完整的使用示例。
使用 metalsmith-frontmatter 插件可以帮助我们更加高效地处理文本文件，从而将注意力集中于网站内容的编写。在实际开发中，我们可以根据自己的需求选择合适的插件进行配置，从而提高文本文件处理的效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066f3f1d8e776d08040bac