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 }