mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 04:48:33 +07:00
ab42f0d097
* HTML-ize code blocks inside a markdown table. Single line break. Add support for embedding markdown code blocks inside markdown tables Add support for single-line breaks: when the line ends with 2 spaces, place a single <br>. * Fix the testsuite, todo improve the escape code for document * Add the WithIndent testdata
147 lines
1.6 KiB
Plaintext
147 lines
1.6 KiB
Plaintext
Usage:
|
|
|
|
module "foo" {
|
|
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"
|
|
}
|
|
}
|
|
|
|
## Inputs
|
|
|
|
The following input variables are supported:
|
|
|
|
### unquoted
|
|
|
|
Description:
|
|
|
|
Type: `string`
|
|
|
|
Default: n/a
|
|
|
|
### string-3
|
|
|
|
Description:
|
|
|
|
Type: `string`
|
|
|
|
Default: `""`
|
|
|
|
### string-2
|
|
|
|
Description: It's string number two.
|
|
|
|
Type: `string`
|
|
|
|
Default: n/a
|
|
|
|
### string-1
|
|
|
|
Description: It's string number one.
|
|
|
|
Type: `string`
|
|
|
|
Default: `"bar"`
|
|
|
|
### map-3
|
|
|
|
Description:
|
|
|
|
Type: `map`
|
|
|
|
Default: `<map>`
|
|
|
|
### map-2
|
|
|
|
Description: It's map number two.
|
|
|
|
Type: `map`
|
|
|
|
Default: n/a
|
|
|
|
### map-1
|
|
|
|
Description: It's map number one.
|
|
|
|
Type: `map`
|
|
|
|
Default: `<map>`
|
|
|
|
### list-3
|
|
|
|
Description:
|
|
|
|
Type: `list`
|
|
|
|
Default: `<list>`
|
|
|
|
### list-2
|
|
|
|
Description: It's list number two.
|
|
|
|
Type: `list`
|
|
|
|
Default: n/a
|
|
|
|
### list-1
|
|
|
|
Description: It's list number one.
|
|
|
|
Type: `list`
|
|
|
|
Default: `<list>`
|
|
|
|
### input\_with\_underscores
|
|
|
|
Description: A variable with underscores.
|
|
|
|
Type: `string`
|
|
|
|
Default: n/a
|
|
|
|
### input-with-pipe
|
|
|
|
Description: It includes v1 \| v2 \| v3
|
|
|
|
Type: `string`
|
|
|
|
Default: `"v1"`
|
|
|
|
### 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: `<list>`
|
|
|
|
## Outputs
|
|
|
|
The following outputs are exported:
|
|
|
|
### unquoted
|
|
|
|
Description: It's unquoted output.
|
|
|
|
### output-2
|
|
|
|
Description: It's output number two.
|
|
|
|
### output-1
|
|
|
|
Description: It's output number one.
|