frontmatter()

Markdown/MDX ドキュメントの先頭にある YAML、TOML、JSON のメタデータブロックのパースを有効にする frontmatter プラグインを生成します。

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 }