1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

# terraform-docs configuration

formatter: markdown table

output:
  file: README.md
  mode: inject
  template: |-
    <!-- BEGIN_TF_DOCS — DO NOT EDIT BELOW THIS LINE -->
    {{ .Content }}
    <!-- END_TF_DOCS — DO NOT EDIT ABOVE THIS LINE -->

sections:
  show:
    - requirements
    - providers
    - modules
    - resources
    - inputs
    - outputs

settings:
  indent: 2
  required: true
  sensitive: true
  default: true
  description: true
  escape: false
  hide-empty: true

sort:
  enabled: true
  by: required