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 }