Since v0.10.0

Relative path to a file to extract header for the generated output from. Supported file formats are .adoc, .md, .tf, and .txt.

To extract header from .tf file you need to use following javascript, c, or java like multi-line comment.

 * # Main title
 * Everything in this comment block will get extracted.
 * You can put simple text or complete Markdown content
 * here. Subsequently if you want to render AsciiDoc format
 * you can put AsciiDoc compatible content in this comment
 * block.

resource "foo" "bar" { ... }


Available options with their default values.

header-from: main.tf


Read header.md to extract header:

header-from: header.md

Read docs/.header.md to extract header:

header-from: "docs/.header.md"

Edit on GitHub