mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-04-12 07:07:02 +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>
11 KiB
11 KiB
title, description, menu, weight, toc
| title | description | menu | weight | toc | ||||
|---|---|---|---|---|---|---|---|---|
| markdown document | Generate Markdown document of inputs and outputs. |
|
956 | true |
Synopsis
Generate Markdown document of inputs and outputs.
terraform-docs markdown document [PATH] [flags]
Options
-h, --help help for document
Inherited Options
--anchor create anchor links (default true)
-c, --config string config file name (default ".terraform-docs.yml")
--default show Default column or section (default true)
--escape escape special characters (default true)
--header-from string relative path of a file to read header from (default "main.tf")
--hide strings hide section [header, inputs, modules, outputs, providers, requirements, resources]
--hide-all hide all sections (default false)
--indent int indention level of Markdown sections [1, 2, 3, 4, 5] (default 2)
--output-file string File in module directory to insert output into (default "")
--output-mode string Output to file method [inject, replace] (default "inject")
--output-template string Output template (default "<!-- BEGIN_TF_DOCS -->\n{{ .Content }}\n<!-- END_TF_DOCS -->")
--output-values inject output values into outputs (default false)
--output-values-from string inject output values from file into outputs (default "")
--required show Required column or section (default true)
--sensitive show Sensitive column or section (default true)
--show strings show section [header, inputs, modules, outputs, providers, requirements, resources]
--show-all show all sections (default true)
--sort sort items (default true)
--sort-by-required sort items by name and print required ones first (default false)
--sort-by-type sort items by type of them (default false)
--type show Type column or section (default true)
Example
Given the examples module:
terraform-docs markdown document ./examples/
generates the following output:
Usage:
Example of 'foo\_bar' module in `foo_bar.tf`.
- list item 1
- list item 2
Even inline **formatting** in _here_ is possible.
and some [link](https://domain.com/)
* list item 3
* list item 4
```hcl
module "foo_bar" {
source = "github.com/foo/bar"
id = "1234567890"
name = "baz"
zones = ["us-east-1", "us-west-1"]
tags = {
Name = "baz"
Created-By = "first.last@email.com"
Date-Created = "20180101"
}
}
```
Here is some trailing text after code block,
followed by another line of text.
| Name | Description |
|------|-----------------|
| Foo | Foo description |
| Bar | Bar description |
## Requirements
The following requirements are needed by this module:
- <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) (>= 0.12)
- <a name="requirement_aws"></a> [aws](#requirement\_aws) (>= 2.15.0)
- <a name="requirement_random"></a> [random](#requirement\_random) (>= 2.2.0)
## Providers
The following providers are used by this module:
- <a name="provider_aws"></a> [aws](#provider\_aws) (>= 2.15.0)
- <a name="provider_aws.ident"></a> [aws.ident](#provider\_aws.ident) (>= 2.15.0)
- <a name="provider_null"></a> [null](#provider\_null)
- <a name="provider_tls"></a> [tls](#provider\_tls)
## Modules
The following Modules are called:
### <a name="module_bar"></a> [bar](#module\_bar)
Source: baz
Version: 4.5.6
### <a name="module_baz"></a> [baz](#module\_baz)
Source: baz
Version: 4.5.6
### <a name="module_foo"></a> [foo](#module\_foo)
Source: bar
Version: 1.2.3
## Resources
The following resources are used by this module:
- [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity)
- [aws_caller_identity.ident](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity)
- [null_resource.foo](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource)
- [tls_private_key.baz](https://registry.terraform.io/providers/hashicorp/tls/latest/docs/resources/private_key)
## Required Inputs
The following input variables are required:
### <a name="input_input_with_underscores"></a> [input\_with\_underscores](#input\_input\_with\_underscores)
Description: A variable with underscores.
Type: `any`
### <a name="input_list-2"></a> [list-2](#input\_list-2)
Description: It's list number two.
Type: `list`
### <a name="input_map-2"></a> [map-2](#input\_map-2)
Description: It's map number two.
Type: `map`
### <a name="input_number-2"></a> [number-2](#input\_number-2)
Description: It's number number two.
Type: `number`
### <a name="input_string-2"></a> [string-2](#input\_string-2)
Description: It's string number two.
Type: `string`
### <a name="input_string_no_default"></a> [string\_no\_default](#input\_string\_no\_default)
Description: n/a
Type: `string`
### <a name="input_unquoted"></a> [unquoted](#input\_unquoted)
Description: n/a
Type: `any`
## Optional Inputs
The following input variables are optional (have default values):
### <a name="input_bool-1"></a> [bool-1](#input\_bool-1)
Description: It's bool number one.
Type: `bool`
Default: `true`
### <a name="input_bool-2"></a> [bool-2](#input\_bool-2)
Description: It's bool number two.
Type: `bool`
Default: `false`
### <a name="input_bool-3"></a> [bool-3](#input\_bool-3)
Description: n/a
Type: `bool`
Default: `true`
### <a name="input_bool_default_false"></a> [bool\_default\_false](#input\_bool\_default\_false)
Description: n/a
Type: `bool`
Default: `false`
### <a name="input_input-with-code-block"></a> [input-with-code-block](#input\_input-with-code-block)
Description: This is a complicated one. We need a newline.
And an example in a code block
```
default = [
"machine rack01:neptune"
]
```
Type: `list`
Default:
```json
[
"name rack:location"
]
```
### <a name="input_input-with-pipe"></a> [input-with-pipe](#input\_input-with-pipe)
Description: It includes v1 | v2 | v3
Type: `string`
Default: `"v1"`
### <a name="input_list-1"></a> [list-1](#input\_list-1)
Description: It's list number one.
Type: `list`
Default:
```json
[
"a",
"b",
"c"
]
```
### <a name="input_list-3"></a> [list-3](#input\_list-3)
Description: n/a
Type: `list`
Default: `[]`
### <a name="input_list_default_empty"></a> [list\_default\_empty](#input\_list\_default\_empty)
Description: n/a
Type: `list(string)`
Default: `[]`
### <a name="input_long_type"></a> [long\_type](#input\_long\_type)
Description: This description is itself markdown.
It spans over multiple lines.
Type:
```hcl
object({
name = string,
foo = object({ foo = string, bar = string }),
bar = object({ foo = string, bar = string }),
fizz = list(string),
buzz = list(string)
})
```
Default:
```json
{
"bar": {
"bar": "bar",
"foo": "bar"
},
"buzz": [
"fizz",
"buzz"
],
"fizz": [],
"foo": {
"bar": "foo",
"foo": "foo"
},
"name": "hello"
}
```
### <a name="input_map-1"></a> [map-1](#input\_map-1)
Description: It's map number one.
Type: `map`
Default:
```json
{
"a": 1,
"b": 2,
"c": 3
}
```
### <a name="input_map-3"></a> [map-3](#input\_map-3)
Description: n/a
Type: `map`
Default: `{}`
### <a name="input_no-escape-default-value"></a> [no-escape-default-value](#input\_no-escape-default-value)
Description: The description contains `something_with_underscore`. Defaults to 'VALUE\_WITH\_UNDERSCORE'.
Type: `string`
Default: `"VALUE_WITH_UNDERSCORE"`
### <a name="input_number-1"></a> [number-1](#input\_number-1)
Description: It's number number one.
Type: `number`
Default: `42`
### <a name="input_number-3"></a> [number-3](#input\_number-3)
Description: n/a
Type: `number`
Default: `"19"`
### <a name="input_number-4"></a> [number-4](#input\_number-4)
Description: n/a
Type: `number`
Default: `15.75`
### <a name="input_number_default_zero"></a> [number\_default\_zero](#input\_number\_default\_zero)
Description: n/a
Type: `number`
Default: `0`
### <a name="input_object_default_empty"></a> [object\_default\_empty](#input\_object\_default\_empty)
Description: n/a
Type: `object({})`
Default: `{}`
### <a name="input_string-1"></a> [string-1](#input\_string-1)
Description: It's string number one.
Type: `string`
Default: `"bar"`
### <a name="input_string-3"></a> [string-3](#input\_string-3)
Description: n/a
Type: `string`
Default: `""`
### <a name="input_string-special-chars"></a> [string-special-chars](#input\_string-special-chars)
Description: n/a
Type: `string`
Default: `"\\.<>[]{}_-"`
### <a name="input_string_default_empty"></a> [string\_default\_empty](#input\_string\_default\_empty)
Description: n/a
Type: `string`
Default: `""`
### <a name="input_string_default_null"></a> [string\_default\_null](#input\_string\_default\_null)
Description: n/a
Type: `string`
Default: `null`
### <a name="input_with-url"></a> [with-url](#input\_with-url)
Description: The description contains url. https://www.domain.com/foo/bar_baz.html
Type: `string`
Default: `""`
## Outputs
The following outputs are exported:
### <a name="output_output-0.12"></a> [output-0.12](#output\_output-0.12)
Description: terraform 0.12 only
### <a name="output_output-1"></a> [output-1](#output\_output-1)
Description: It's output number one.
### <a name="output_output-2"></a> [output-2](#output\_output-2)
Description: It's output number two.
### <a name="output_unquoted"></a> [unquoted](#output\_unquoted)
Description: It's unquoted output.