.terraform-docs-example.yaml

  formatter: "markdown table"

  header-from: ../../example.header.md
  footer-from: ""

  recursive:
    enabled: true
    path: examples
    include-main: false

  output:
    file: "README.md"
    mode: replace
    template: |-
      <!-- BEGIN_TF_DOCS -->
      {{ .Content }}
      <!-- END_TF_DOCS -->
      {{- printf "\n" -}}

  sort:
    enabled: true
    by: name

  settings:
    anchor: true
    color: true
    default: true
    description: false
    escape: true
    hide-empty: false
    html: true
    indent: 2
    lockfile: true
    read-comments: true
    required: true
    sensitive: true
    type: true