.terraform-docs.yml

formatter: "markdown"
version: "0.19.0"

output:
  file: "README.md"
  mode: "inject"
  template: |-
    <!-- BEGIN_TF_DOCS -->
    ## terraform-docs

    > [!WARNING]
    > This part of the README is automatically generated by terraform-docs! Please don't manually edit me! Instead, run `terraform-docs --config .terraform-docs.yml <directory>`, replacing `<directory>` with the directory you want to update from the root of the repo!

    {{ .Content }}
    <!-- END_TF_DOCS -->

sort:
  enabled: true
  by: name

settings:
  anchor: true
  color: true
  description: true
  hide-empty: true
  lockfile: true
  indent: 2