mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 12:58:35 +07:00
6777364257
Generated content can be customized further away with `content` in configuration.
If the `content` is empty the default orders of section is used. `content` is a
Go template with following additional variables:
- `{{ .Header }}`
- `{{ .Footer }}`
- `{{ .Inputs }}`
- `{{ .Modules }}`
- `{{ .Outputs }}`
- `{{ .Providers }}`
- `{{ .Requirements }}`
- `{{ .Resources }}`
```yaml
content: |-
Any arbitrary text can be placed anywhere in the content
{{ .Header }}
and even in between sections
{{ .Providers }}
and they don't even need to be in the default order
{{ .Outputs }}
{{ .Inputs }}
```
These variables are the generated output of individual sections in the selected
formatter. For example `{{ .Inputs }}` is Markdown Table representation of inputs
when formatter is set to `markdown table` and AsciiDoc Document representation
when formatter is set to `asciidoc document` and so on.
Compatible formats for customized content are:
- `asciidoc document`
- `asciidoc table`
- `markdown document`
- `markdown table`
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
61 lines
1.3 KiB
YAML
61 lines
1.3 KiB
YAML
# # see: https://terraform-docs.io/user-guide/configuration/#version
|
|
# version: ">= 0.10, < 0.12"
|
|
|
|
# see: https://terraform-docs.io/user-guide/configuration/#formatters
|
|
formatter: markdown table
|
|
|
|
header-from: doc.txt
|
|
footer-from: footer.md
|
|
|
|
# see: https://terraform-docs.io/user-guide/configuration/#sections
|
|
sections:
|
|
show:
|
|
- header
|
|
- inputs
|
|
- providers
|
|
- modules
|
|
- footer
|
|
|
|
# # see: https://terraform-docs.io/user-guide/configuration/#content
|
|
# content: |-
|
|
# Any arbitrary text can be placed anywhere in the content
|
|
#
|
|
# {{ .Header }}
|
|
#
|
|
# and even in between sections
|
|
#
|
|
# {{ .Providers }}
|
|
#
|
|
# and they don't even need to be in the default order
|
|
#
|
|
# {{ .Outputs }}
|
|
#
|
|
# {{ .Inputs }}
|
|
|
|
# # see: https://terraform-docs.io/user-guide/configuration/#output
|
|
# output:
|
|
# file: README.md
|
|
# mode: inject
|
|
# template: |-
|
|
# <!-- BEGIN_TF_DOCS -->
|
|
# The template can be customized with aribitrary markdown content.
|
|
# For example this can be shown before the actual content generated
|
|
# by formatters.
|
|
#
|
|
# {{ .Content }}
|
|
#
|
|
# You can also show something after it!
|
|
# <!-- END_TF_DOCS -->
|
|
|
|
# see: https://terraform-docs.io/user-guide/configuration/#sort
|
|
sort:
|
|
enabled: true
|
|
by: required
|
|
|
|
settings:
|
|
indent: 4
|
|
escape: false
|
|
default: false
|
|
required: false
|
|
type: true
|