local_file publisher

blackstork/builtin, v1.0.0

Description #

Writes the rendered document to a local file.

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

Configuration #

This publisher does not accept any configuration arguments.

Usage #

This publisher accepts the following arguments within a publish local_file block:

# The `publish` block also accepts the generic `format_ref` argument to link to a formatter.

publish local_file {
  # Path to the file
  #
  # Required string.
  #
  # For example:
  path = "dist/output.md"
}