Skip to main content

frontmatter

Module for handling frontmatter generation in Markdown documents. Provides utilities for formatting and printing frontmatter content.

printFrontMatter()​

function printFrontMatter(
   title, 
   props, 
   options): string

Defined in: frontmatter.ts:21

Generates a formatted frontmatter string for Markdown/MDX documents.

Parameters​

title​

string

The title to be included in the frontmatter

props​

Maybe<FrontMatterOptions>

Additional frontmatter properties to be included

options​

PrintTypeOptions

Configuration options for printing

Returns​

string

Formatted frontmatter string, or empty string if formatting is disabled