Reference

Options

Configuration for @kubb/parser-md. The parser takes no options. Set file.meta.frontmatter in a plugin to prepend YAML frontmatter to a generated page.

parserMd() takes no options. Control its output through the file metadata below.

Frontmatter

Set file.meta.frontmatter inside a plugin. Any serializable object becomes a YAML block at the top of the generated page.

meta.frontmatter

Record<string, unknown> | null

YAML frontmatter prepended to the generated Markdown file.

import { ast } from 'kubb/kit'

const file = ast.factory.createFile({
  baseName: 'README.md',
  path: './src/gen/README.md',
  meta: {
    frontmatter: { title: 'API Reference', layout: 'doc' },
  },
  sources: [ast.factory.createSource({ nodes: [ast.factory.createText('# API Reference')] })],
})

---
title: API Reference
layout: doc
---

parserMd().print accepts objects and Markdown strings, joined with blank lines.
parserMd().print({ title: 'Pets', layout: 'doc' }) returns ---\ntitle: Pets\nlayout: doc\n---.

Overview