简介
remark-frontmatter 是一个基于 Remark 的插件，用于以 YAML 格式解析 Markdown 文件中的 Front Matter。Front Matter 是指在 Markdown 文件顶部使用三个横线（---）包裹起来的元数据块，通常用于定义一些文档的属性和配置项。
remark-frontmatter 可以将这些元数据解析成一个 JavaScript 对象，并且将其作为 Remark AST 中的一个节点进行处理。这样我们就可以在构建工具或其他应用程序中方便地访问这些元数据了。
下面将详细介绍 remark-frontmatter 的使用方法。
安装
首先，我们需要安装 remark-frontmatter 和 remark：
npm install remark remark-frontmatter
使用
接下来，我们需要在代码中引入 remark 和 remark-frontmatter：
const unified = require('unified');
const markdown = require('remark-parse');
const frontmatter = require('remark-frontmatter');
const processor = unified()
.use(markdown)
.use(frontmatter, ['yaml']); // 支持解析 YAML 格式的 Front Matter在上面的代码中，我们使用 unified() 方法创建了一个 Processor 对象，并依次使用 markdown 和 frontmatter 插件对 Markdown 文件进行解析。frontmatter 插件的第二个参数为 Front Matter 的解析器类型，支持以下几种格式：
'yaml''toml''json''none'
默认值为 'yaml'。
最后，我们可以使用 process() 方法将 Markdown 文本转换成 Remark AST：
-- -------------------- ---- ------- ----- ------------ - - --- ------ ------ ------ ------- ---- --- --- - -- ---- ---- ---- -- --- ------- -- -- ---- ----- -- ----- --- - -------------------------------------------
在上面的代码中，我们定义了一个包含 Front Matter 的 Markdown 文本，并使用 processSync() 方法将其转换为 Remark AST。转换后的 AST 包含了 data 属性，其中的 frontmatter 对象即为解析出来的元数据。
console.log(ast.data.frontmatter);
// 输出：{ title: 'Hello, world!', author: 'John Doe' }接下来，我们可以在构建工具或其他应用程序中使用这些元数据了。
示例代码
下面是一个使用 remark-frontmatter 的示例代码，它会遍历指定目录下的所有 Markdown 文件，并提取它们的 Front Matter：
-- -------------------- ---- -------
----- -- - --------------
----- ---- - ----------------
----- ------ - ------------------
----- ------- - -------------------
----- -------- - ------------------------
----- ----------- - ------------------------------
----- -------- ----------------------- -
----- ----- - ----- ------------------- - ---- --- ---
----- --------- - ---------
--------------
----------------- ----------
------ --------------------------- ---- -- -
----- -------- - -------------- ------
----- ----------- - ----- ------------------------------ --------
----- --- - -----------------------------
----- - ----------- - - -----------------------
------ -
-----
-----------
--
----
-
---------------------------------------- -- -
-------------------
---总结
remark-frontmatter 是一个实用的 Remark 插件，它可以方便地解析 Markdown 文件中的 Front Matter，并将其作为 JavaScript 对象嵌入 Remark AST 中。通过使用这些元数据，我们可以轻松地对文档进行更加灵活和复杂的处理。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/41777