66 lines
1.3 KiB
YAML
66 lines
1.3 KiB
YAML
---
|
|
formatter: "markdown table"
|
|
version: "0.17"
|
|
header-from: ./docs/header.md
|
|
sections:
|
|
show:
|
|
- data-sources
|
|
- header
|
|
- footer
|
|
- inputs
|
|
- modules
|
|
- outputs
|
|
- providers
|
|
- requirements
|
|
- resources
|
|
content: |-
|
|
{{ .Header }}
|
|
{{ .Requirements }}
|
|
{{ .Providers }}
|
|
{{ .Modules }}
|
|
## Usage
|
|
Basic usage of this module is as follows:
|
|
```hcl
|
|
module "example" {
|
|
{{"\t"}} source = "<module-path>"
|
|
{{- if .Module.RequiredInputs }}
|
|
{{"\n\t"}} # Required variables
|
|
{{- range .Module.RequiredInputs }}
|
|
{{"\t"}} {{ .Name }} = {{ .GetValue }}
|
|
{{- end }}
|
|
{{- end }}
|
|
{{- if .Module.OptionalInputs }}
|
|
{{"\n\t"}} # Optional variables
|
|
{{- range .Module.OptionalInputs }}
|
|
{{"\t"}} {{ .Name }} = {{ .GetValue | printf "%s" }}
|
|
{{- end }}
|
|
{{- end }}
|
|
}
|
|
```
|
|
{{ .Resources }}
|
|
{{ .Inputs }}
|
|
{{ .Outputs }}
|
|
output:
|
|
file: README.md
|
|
mode: inject
|
|
template: |-
|
|
<!-- BEGIN_AUTOMATED_TF_DOCS_BLOCK -->
|
|
{{ .Content }}
|
|
<!-- END_AUTOMATED_TF_DOCS_BLOCK -->
|
|
sort:
|
|
enabled: true
|
|
by: name
|
|
settings:
|
|
anchor: true
|
|
color: true
|
|
default: true
|
|
description: true
|
|
escape: false
|
|
hide-empty: false
|
|
html: true
|
|
indent: 2
|
|
lockfile: true
|
|
required: true
|
|
sensitive: true
|
|
type: true
|