mirror of https://github.com/terraform-docs/terraform-docs.git synced 2026-03-27 12:58:35 +07:00

Files

Khosrow Moossavi fd97ec5930 feat: Add support for .terraform-docs.yml config file (#272 )

* Add support for .terraform-docs.yml config file

* add config reader

* add usage documentation and reference guide

* typo

* update docs

2020-07-13 22:06:30 -04:00

863 B

Raw Blame History

Config File Reference

All available options for .terraform-docs.yml. Note that not all of them can be used at the same time (e.g. sections.hide and sections.show)

formatter: <FORMATTER_NAME>
header-from: main.tf

sections:
  hide-all: false
  hide:
    - header
    - inputs
    - outputs
    - providers
    - requirements
  show-all: true
  show:
    - header
    - inputs
    - outputs
    - providers
    - requirements

output-values:
  enabled: false
  from: ""

sort:
  enabled: true
  by:
    - required
    - type

settings:
  color: true
  escape: true
  indent: 2
  required: true
  sensitive: true

Available options for FORMATTER_NAME are:

asciidoc
asciidoc document
asciidoc table
json
markdonw
markdonw document
markdonw table
pretty
tfvars hcl
tfvars json
toml
xml
yaml

863 B Raw Blame History

Config File Reference

863 B

Raw Blame History