md formatter

blackstork/builtin, v1.0.0

Description #

Renders a document as Markdown, with optional YAML, TOML, or JSON front matter.

The md formatter is built into the BlackStork engine. It is available out-of-the-box and requires no installation or dependency declaration.

Configuration #

This formatter does not accept any configuration arguments.

Usage #

This formatter accepts the following arguments within a format md block:

format md {
  # Arbitrary key-value map to be put in the frontmatter
  #
  # Optional jq queriable.
  #
  # For example:
  # frontmatter = {
  #   key = "arbitrary value"
  #   key2 = {
  #     nested_key = 42
  #   }
  # }
  #
  # Default value:
  frontmatter = null

  # Format of the frontmatter.
  #
  # Optional string.
  # Must be one of: "yaml", "toml", "json"
  # Default value:
  frontmatter_format = "yaml"
}