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 [cols="a,a",options="header,autowidth"] |=== |Name |Version |terraform |>= 0.12 |aws |>= 2.15.0 |foo |>= 1.0 |random |>= 2.2.0 |=== == Providers [cols="a,a",options="header,autowidth"] |=== |Name |Version |tls |n/a |foo |>= 1.0 |aws |>= 2.15.0 |aws.ident |>= 2.15.0 |null |n/a |=== == Modules [cols="a,a,a",options="header,autowidth"] |=== |Name |Source |Version |bar |baz |4.5.6 |foo |bar |1.2.3 |baz |baz |4.5.6 |foobar |git@github.com:module/path |v7.8.9 |=== == Resources [cols="a,a",options="header,autowidth"] |=== |Name |Type |foo_resource.baz |resource |https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource[null_resource.foo] |resource |https://registry.terraform.io/providers/hashicorp/tls/latest/docs/resources/private_key[tls_private_key.baz] |resource |https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity[aws_caller_identity.current] |data source |https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity[aws_caller_identity.ident] |data source |=== == Inputs [cols="a,a,a,a",options="header,autowidth"] |=== |Name |Description |Type |Default |unquoted |n/a |`any` |n/a |bool-3 |n/a |`bool` |`true` |bool-2 |It's bool number two. |`bool` |`false` |bool-1 |It's bool number one. |`bool` |`true` |string-3 |n/a |`string` |`""` |string-2 |It's string number two. |`string` |n/a |string-1 |It's string number one. |`string` |`"bar"` |string-special-chars |n/a |`string` |`"\\.<>[]{}_-"` |number-3 |n/a |`number` |`"19"` |number-4 |n/a |`number` |`15.75` |number-2 |It's number number two. |`number` |n/a |number-1 |It's number number one. |`number` |`42` |map-3 |n/a |`map` |`{}` |map-2 |It's map number two. |`map` |n/a |map-1 |It's map number one. |`map` | [source] ---- { "a": 1, "b": 2, "c": 3 } ---- |list-3 |n/a |`list` |`[]` |list-2 |It's list number two. |`list` |n/a |list-1 |It's list number one. |`list` | [source] ---- [ "a", "b", "c" ] ---- |input_with_underscores |A variable with underscores. |`any` |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. And an example in a code block [source] ---- default = [ "machine rack01:neptune" ] ---- |`list` | [source] ---- [ "name rack:location" ] ---- |long_type |This description is itself markdown. It spans over multiple lines. | [source] ---- object({ name = string, foo = object({ foo = string, bar = string }), bar = object({ foo = string, bar = string }), fizz = list(string), buzz = list(string) }) ---- | [source] ---- { "bar": { "bar": "bar", "foo": "bar" }, "buzz": [ "fizz", "buzz" ], "fizz": [], "foo": { "bar": "foo", "foo": "foo" }, "name": "hello" } ---- |no-escape-default-value |The description contains `something_with_underscore`. Defaults to 'VALUE_WITH_UNDERSCORE'. |`string` |`"VALUE_WITH_UNDERSCORE"` |with-url |The description contains url. https://www.domain.com/foo/bar_baz.html |`string` |`""` |string_default_empty |n/a |`string` |`""` |string_default_null |n/a |`string` |`null` |string_no_default |n/a |`string` |n/a |number_default_zero |n/a |`number` |`0` |bool_default_false |n/a |`bool` |`false` |list_default_empty |n/a |`list(string)` |`[]` |object_default_empty |n/a |`object({})` |`{}` |=== == Outputs [cols="a,a",options="header,autowidth"] |=== |Name |Description |unquoted |It's unquoted output. |output-2 |It's output number two. |output-1 |It's output number one. |output-0.12 |terraform 0.12 only |=== ## This is an example of a footer It looks exactly like a header, but is placed at the end of the document