mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 12:58:35 +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
43 lines
1.3 KiB
Plaintext
43 lines
1.3 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
|
|
|
|
| Name | Description | Type | Default |
|
|
|------|-------------|:----:|:-----:|
|
|
| unquoted | | string | n/a |
|
|
| string-3 | | string | `""` |
|
|
| string-2 | It's string number two. | string | n/a |
|
|
| string-1 | It's string number one. | string | `"bar"` |
|
|
| map-3 | | map | `<map>` |
|
|
| map-2 | It's map number two. | map | n/a |
|
|
| map-1 | It's map number one. | map | `<map>` |
|
|
| list-3 | | list | `<list>` |
|
|
| list-2 | It's list number two. | list | n/a |
|
|
| list-1 | It's list number one. | list | `<list>` |
|
|
| input_with_underscores | A variable with underscores. | string | n/a |
|
|
| input-with-pipe | It includes v1 \| v2 \| v3 | string | `"v1"` |
|
|
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<code><pre>default = [<br> "machine rack01:neptune"<br>]<br></pre></code> | list | `<list>` |
|
|
|
|
## Outputs
|
|
|
|
| Name | Description |
|
|
|------|-------------|
|
|
| unquoted | It's unquoted output. |
|
|
| output-2 | It's output number two. |
|
|
| output-1 | It's output number one. |
|