Include Examples
Since v0.14.0
Example can be automatically included into README by using content
in configuration
file. For example:
$ tree
.
├── examples
│ ├── example-1
│ │ ├── main.tf
│ └── example-2
│ └── main.tf
├── ...
├── main.tf
├── variables.tf
├── ...
└── .terraform-docs.yml
and
# .terraform-docs.yml
content: |-
{{ .Header }}
## Example
```hcl
{{ include "examples/example-1/main.tf" }}
```
{{ .Inputs }}
{{ .Outputs }}