mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 04:48:33 +07:00
Add support for footer docs
Enables a footer to be appended to the end of a generated document sourced from tf files or documents in the same way as the header Adds the `footer-from` field to the config yml Adds the `--footer-from` flag to the cli Signed-off-by: Simon Clifford <siclifford@gmail.com> Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
This commit is contained in:
committed by
Khosrow Moossavi
parent
5fae473131
commit
aa1e6bbf59
@@ -1,5 +1,7 @@
|
||||
formatter: markdown table
|
||||
header-from: doc.txt
|
||||
footer-from: footer.md
|
||||
|
||||
sections:
|
||||
hide-all: true
|
||||
show:
|
||||
@@ -7,6 +9,7 @@ sections:
|
||||
- inputs
|
||||
- providers
|
||||
- modules
|
||||
- footer
|
||||
|
||||
# output:
|
||||
# file: README.md
|
||||
|
||||
3
examples/footer.md
Normal file
3
examples/footer.md
Normal file
@@ -0,0 +1,3 @@
|
||||
## This is an example of a footer
|
||||
|
||||
It looks exactly like a header, but is placed at the end of the document
|
||||
Reference in New Issue
Block a user