frontmatter()

Cria um plugin de frontmatter que habilita o parsing de blocos de metadados YAML, TOML ou JSON no topo de documentos Markdown/MDX.

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

Assinatura

function frontmatter(options?: FrontmatterPluginOptions): UnifastPlugin

Parâmetros

options?

Configuração para os formatos de frontmatter

Propriedade	Tipo	Padrão	Descrição
`yaml`	`boolean`	`true`	Habilita frontmatter YAML (delimitadores —)
`toml`	`boolean`	`false`	Habilita frontmatter TOML (delimitadores +++)
`json`	`boolean`	`false`	Habilita frontmatter JSON (delimitadores ;;;)

Uso

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"] }

Exemplos

Frontmatter YAML

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"] }

Frontmatter TOML

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" }

Frontmatter JSON

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 }