mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-31 23:08:43 +07:00
a3bafd6018
There are two modes for saving into file:
- inject: partially replace the target file with generated output
- replace: completely replace the target file with generated output
The output generated by formatters (markdown, asciidoc, etc) will be
inserted into a template before getting saved into the file. This
template can be customized with '--output-template' CLI flag or
corresponding item in '.terraform-docs.yml' config file. Its default
value is:
```
<!-- BEGIN_TF_DOCS -->
{{ .Content }}
<!-- END_TF_DOCS -->
```
This consists of three items, all of them are mandatory:
- begin comment
- content variable
- end comment
You may change the wording of comment as you wish, but the comment must
be present in the template.
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
386 B
386 B
Foo
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Bar
sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
- Ut enim ad minim veniam
- quis nostrud exercitation
ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit
Baz
esse cillum dolore eu fugiat nulla pariatur.