frontmatter()

创建 frontmatter 插件，用于解析位于 Markdown/MDX 文档顶部的 YAML、TOML 或 JSON 元数据块。

import { frontmatter } from "@unifast/node";

签名

function frontmatter(options?: FrontmatterPluginOptions): UnifastPlugin

参数

options?

Frontmatter 格式的配置

属性	类型	默认值	描述
`yaml`	`boolean`	`true`	启用 YAML frontmatter（使用 — 作为分隔符）
`toml`	`boolean`	`false`	启用 TOML frontmatter（使用 +++ 作为分隔符）
`json`	`boolean`	`false`	启用 JSON frontmatter（使用 ;;; 作为分隔符）

用法

import { compile, frontmatter } from "@unifast/node";

const result = compile(md, {
  plugins: [
    frontmatter({
      yaml: true,
      toml: true,
      json: true,
    }),
  ],
});

console.log(result.frontmatter);
// { title: "My Page", date: "2024-01-01", tags: ["markdown", "docs"] }

示例

YAML Frontmatter

import { compile, frontmatter } from "@unifast/node";

const md = `---
title: My Page
date: 2024-01-01
tags:
  - markdown
  - docs
---

# Hello`;

const result = compile(md, { plugins: [frontmatter()] });

console.log(result.frontmatter);
// { title: "My Page", date: "2024-01-01", tags: ["markdown", "docs"] }

TOML Frontmatter

import { compile, frontmatter } from "@unifast/node";

const md = `+++
title = "My Page"
date = 2024-01-01
+++

# Hello`;

const result = compile(md, { plugins: [frontmatter({ toml: true })] });

console.log(result.frontmatter);
// { title: "My Page", date: "2024-01-01" }

JSON Frontmatter

import { compile, frontmatter } from "@unifast/node";

const md = `;;;
{"title": "My Page", "draft": false}
;;;

# Hello`;

const result = compile(md, { plugins: [frontmatter({ json: true })] });

console.log(result.frontmatter);
// { title: "My Page", draft: false }