Parse YAML/JSON/TOML front-matter from strings or files using the gray-matter library — 使用 gray-matter 库从字符串或文件中解析 YAML/JSON/TOML 前置内容（front-matter）

Gray Matter 解析 YAML/JSON/TOML/CSON/CoffeeScript 前置元数据（front-matter）从字符串或文件中。使用时机是在处理具有前置元数据（YAML/JSON/TOML 头部）的 markdown 文件时，提取具有 ---- 分隔符的文档元数据，字符串化数据回前置元数据格式，或涉及前置元数据解析/字符串化的任何任务。触发关键词有 "front matter"、"frontmatter"、"gray-matter"、"YAML 头部"、"解析 markdown 元数据"、"提取前置元数据"、"添加前置元数据"、"字符串化前置元数据"。

快速开始 使用 scripts/parse.js 脚本进行所有前置元数据操作： # 解析文件中的前置元数据（输出 JSON） node scripts/parse.js path/to/file.md # 从管道标准输入解析 type file.md | node scripts/parse.js --stdin # 仅输出前置元数据数据（YAML 格式） node scripts/parse.js file.md --data-only # 仅输出内容（无前置元数据） node scripts/parse.js file.md --content-only # 包含摘要在输出中 node scripts/parse.js file.md --excerpt # 强制指定语言 node scripts/parse.js file.md --lang json # 自定义分隔符 node scripts/parse.js file.md --delims "~~~" # 测试文件是否具有前置元数据 node scripts/parse.js file.md --test # 字符串化：将 JSON 数据写入临时文件，然后： node scripts/parse.js data.json --stringify # 输出前置元数据分隔符包裹的 YAML 序列化数据

常见操作

• 从 markdown 文件中提取元数据

node scripts/parse.js path/to/post.md --data-only

• 去除前置元数据，保留内容

node scripts/parse.js path/to/post.md --content-only

• 检查文件是否具有前置元数据

node scripts/parse.js path/to/file.md --test # 输出：true 或 false

• 添加前置元数据到内容

将 JSON 数据写入临时文件，然后字符串化： node scripts/parse.js _data.json --stringify # 在空内容前添加 YAML 前置元数据（带有 --- 分隔符）

• 解析 TOML 前置元数据

gray-matter 默认不包含 TOML 引擎。首先安装 toml 包： cd /scripts && npm install toml 然后使用内联 require('gray-matter') 带有自定义引擎： const toml = require('toml'); const matter = require('gray-matter'); const result = matter(str, { engines: { toml: toml.parse.bind(toml) }, language: 'toml' }); 或者，gray-matter 可以自动检测语言，当在分隔符行中指定时： ---toml title = "My Post"

---

何时使用脚本与内联代码 使用脚本（上述）进行大多数操作——它可靠地处理边缘情况 仅当进行程序化转换（迭代多个文件、条件逻辑、自定义引擎集成）时，使用内联 require('gray-matter')。在这种情况下，请参阅 references/api.md 获取完整的 API。

脚本安装 脚本将自动通过 npm install gray-matter 安装 gray-matter。在第一次运行时，如果自动安装失败，请手动运行： cd /scripts && npm install gray-matter

参考 请参阅 references/api.md 获取完整的 gray-matter API 文档（主函数、静态方法、所有选项、引擎、废弃选项）。