mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 12:58:35 +07:00
fix: Replace <br> with <br /> for markdown syntax
<br /> provides additional support for XHTML without breaking compatibility with HTML. This can be useful when trying to publish documentation generated by terraform-docs to XHTML based solutions Signed-off-by: christophe.vandekerchove <christophe.vandekerchove@scalepad.com>
This commit is contained in:
christophe.vandekerchove
8
format/testdata/markdown/table-Base.golden
vendored
8
format/testdata/markdown/table-Base.golden
vendored
@@ -92,14 +92,14 @@ followed by another line of text.
|
||||
| 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` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}</pre> |
|
||||
| map-1 | It's map number one. | `map` | <pre>{<br/> "a": 1,<br/> "b": 2,<br/> "c": 3<br/>}</pre> |
|
||||
| list-3 | n/a | `list` | `[]` |
|
||||
| list-2 | It's list number two. | `list` | n/a |
|
||||
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]</pre> |
|
||||
| list-1 | It's list number one. | `list` | <pre>[<br/> "a",<br/> "b",<br/> "c"<br/>]</pre> |
|
||||
| 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.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]</pre> | `list` | <pre>[<br> "name rack:location"<br>]</pre> |
|
||||
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })</pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}</pre> |
|
||||
| input-with-code-block | This is a complicated one. We need a newline.<br/>And an example in a code block<pre>default = [<br/> "machine rack01:neptune"<br/>]</pre> | `list` | <pre>[<br/> "name rack:location"<br/>]</pre> |
|
||||
| long_type | This description is itself markdown.<br/><br/>It spans over multiple lines. | <pre>object({<br/> name = string,<br/> foo = object({ foo = string, bar = string }),<br/> bar = object({ foo = string, bar = string }),<br/> fizz = list(string),<br/> buzz = list(string)<br/> })</pre> | <pre>{<br/> "bar": {<br/> "bar": "bar",<br/> "foo": "bar"<br/> },<br/> "buzz": [<br/> "fizz",<br/> "buzz"<br/> ],<br/> "fizz": [],<br/> "foo": {<br/> "bar": "foo",<br/> "foo": "foo"<br/> },<br/> "name": "hello"<br/>}</pre> |
|
||||
| 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` | `""` |
|
||||
|
||||
@@ -92,14 +92,14 @@ followed by another line of text.
|
||||
| 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` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}</pre> |
|
||||
| map-1 | It's map number one. | `map` | <pre>{<br/> "a": 1,<br/> "b": 2,<br/> "c": 3<br/>}</pre> |
|
||||
| list-3 | n/a | `list` | `[]` |
|
||||
| list-2 | It's list number two. | `list` | n/a |
|
||||
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]</pre> |
|
||||
| list-1 | It's list number one. | `list` | <pre>[<br/> "a",<br/> "b",<br/> "c"<br/>]</pre> |
|
||||
| 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.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]</pre> | `list` | <pre>[<br> "name rack:location"<br>]</pre> |
|
||||
| long\_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })</pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}</pre> |
|
||||
| input-with-code-block | This is a complicated one. We need a newline.<br/>And an example in a code block<pre>default = [<br/> "machine rack01:neptune"<br/>]</pre> | `list` | <pre>[<br/> "name rack:location"<br/>]</pre> |
|
||||
| long\_type | This description is itself markdown.<br/><br/>It spans over multiple lines. | <pre>object({<br/> name = string,<br/> foo = object({ foo = string, bar = string }),<br/> bar = object({ foo = string, bar = string }),<br/> fizz = list(string),<br/> buzz = list(string)<br/> })</pre> | <pre>{<br/> "bar": {<br/> "bar": "bar",<br/> "foo": "bar"<br/> },<br/> "buzz": [<br/> "fizz",<br/> "buzz"<br/> ],<br/> "fizz": [],<br/> "foo": {<br/> "bar": "foo",<br/> "foo": "foo"<br/> },<br/> "name": "hello"<br/>}</pre> |
|
||||
| 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` | `""` |
|
||||
|
||||
@@ -92,14 +92,14 @@ followed by another line of text.
|
||||
| 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` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}</pre> |
|
||||
| map-1 | It's map number one. | `map` | <pre>{<br/> "a": 1,<br/> "b": 2,<br/> "c": 3<br/>}</pre> |
|
||||
| list-3 | n/a | `list` | `[]` |
|
||||
| list-2 | It's list number two. | `list` | n/a |
|
||||
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]</pre> |
|
||||
| list-1 | It's list number one. | `list` | <pre>[<br/> "a",<br/> "b",<br/> "c"<br/>]</pre> |
|
||||
| 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.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]</pre> | `list` | <pre>[<br> "name rack:location"<br>]</pre> |
|
||||
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })</pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}</pre> |
|
||||
| input-with-code-block | This is a complicated one. We need a newline.<br/>And an example in a code block<pre>default = [<br/> "machine rack01:neptune"<br/>]</pre> | `list` | <pre>[<br/> "name rack:location"<br/>]</pre> |
|
||||
| long_type | This description is itself markdown.<br/><br/>It spans over multiple lines. | <pre>object({<br/> name = string,<br/> foo = object({ foo = string, bar = string }),<br/> bar = object({ foo = string, bar = string }),<br/> fizz = list(string),<br/> buzz = list(string)<br/> })</pre> | <pre>{<br/> "bar": {<br/> "bar": "bar",<br/> "foo": "bar"<br/> },<br/> "buzz": [<br/> "fizz",<br/> "buzz"<br/> ],<br/> "fizz": [],<br/> "foo": {<br/> "bar": "foo",<br/> "foo": "foo"<br/> },<br/> "name": "hello"<br/>}</pre> |
|
||||
| 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` | `""` |
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
| Name | Description | Value | Sensitive |
|
||||
|------|-------------|-------|:---------:|
|
||||
| unquoted | It's unquoted output. | <pre>{<br> "leon": "cat"<br>}</pre> | no |
|
||||
| output-2 | It's output number two. | <pre>[<br> "jack",<br> "lola"<br>]</pre> | no |
|
||||
| unquoted | It's unquoted output. | <pre>{<br/> "leon": "cat"<br/>}</pre> | no |
|
||||
| output-2 | It's output number two. | <pre>[<br/> "jack",<br/> "lola"<br/>]</pre> | no |
|
||||
| output-1 | It's output number one. | `1` | no |
|
||||
| output-0.12 | terraform 0.12 only | `<sensitive>` | yes |
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| unquoted | It's unquoted output. | <pre>{<br> "leon": "cat"<br>}</pre> |
|
||||
| output-2 | It's output number two. | <pre>[<br> "jack",<br> "lola"<br>]</pre> |
|
||||
| unquoted | It's unquoted output. | <pre>{<br/> "leon": "cat"<br/>}</pre> |
|
||||
| output-2 | It's output number two. | <pre>[<br/> "jack",<br/> "lola"<br/>]</pre> |
|
||||
| output-1 | It's output number one. | `1` |
|
||||
| output-0.12 | terraform 0.12 only | `<sensitive>` |
|
||||
@@ -92,14 +92,14 @@ followed by another line of text.
|
||||
| <a name="input_number-1"></a> [number-1](#input_number-1) | It's number number one. | `number` | `42` |
|
||||
| <a name="input_map-3"></a> [map-3](#input_map-3) | n/a | `map` | `{}` |
|
||||
| <a name="input_map-2"></a> [map-2](#input_map-2) | It's map number two. | `map` | n/a |
|
||||
| <a name="input_map-1"></a> [map-1](#input_map-1) | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}</pre> |
|
||||
| <a name="input_map-1"></a> [map-1](#input_map-1) | It's map number one. | `map` | <pre>{<br/> "a": 1,<br/> "b": 2,<br/> "c": 3<br/>}</pre> |
|
||||
| <a name="input_list-3"></a> [list-3](#input_list-3) | n/a | `list` | `[]` |
|
||||
| <a name="input_list-2"></a> [list-2](#input_list-2) | It's list number two. | `list` | n/a |
|
||||
| <a name="input_list-1"></a> [list-1](#input_list-1) | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]</pre> |
|
||||
| <a name="input_list-1"></a> [list-1](#input_list-1) | It's list number one. | `list` | <pre>[<br/> "a",<br/> "b",<br/> "c"<br/>]</pre> |
|
||||
| <a name="input_input_with_underscores"></a> [input_with_underscores](#input_input_with_underscores) | A variable with underscores. | `any` | n/a |
|
||||
| <a name="input_input-with-pipe"></a> [input-with-pipe](#input_input-with-pipe) | It includes v1 \| v2 \| v3 | `string` | `"v1"` |
|
||||
| <a name="input_input-with-code-block"></a> [input-with-code-block](#input_input-with-code-block) | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]</pre> | `list` | <pre>[<br> "name rack:location"<br>]</pre> |
|
||||
| <a name="input_long_type"></a> [long_type](#input_long_type) | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })</pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}</pre> |
|
||||
| <a name="input_input-with-code-block"></a> [input-with-code-block](#input_input-with-code-block) | This is a complicated one. We need a newline.<br/>And an example in a code block<pre>default = [<br/> "machine rack01:neptune"<br/>]</pre> | `list` | <pre>[<br/> "name rack:location"<br/>]</pre> |
|
||||
| <a name="input_long_type"></a> [long_type](#input_long_type) | This description is itself markdown.<br/><br/>It spans over multiple lines. | <pre>object({<br/> name = string,<br/> foo = object({ foo = string, bar = string }),<br/> bar = object({ foo = string, bar = string }),<br/> fizz = list(string),<br/> buzz = list(string)<br/> })</pre> | <pre>{<br/> "bar": {<br/> "bar": "bar",<br/> "foo": "bar"<br/> },<br/> "buzz": [<br/> "fizz",<br/> "buzz"<br/> ],<br/> "fizz": [],<br/> "foo": {<br/> "bar": "foo",<br/> "foo": "foo"<br/> },<br/> "name": "hello"<br/>}</pre> |
|
||||
| <a name="input_no-escape-default-value"></a> [no-escape-default-value](#input_no-escape-default-value) | The description contains `something_with_underscore`. Defaults to 'VALUE_WITH_UNDERSCORE'. | `string` | `"VALUE_WITH_UNDERSCORE"` |
|
||||
| <a name="input_with-url"></a> [with-url](#input_with-url) | The description contains url. https://www.domain.com/foo/bar_baz.html | `string` | `""` |
|
||||
| <a name="input_string_default_empty"></a> [string_default_empty](#input_string_default_empty) | n/a | `string` | `""` |
|
||||
|
||||
@@ -92,14 +92,14 @@ followed by another line of text.
|
||||
| number-1 | It's number number one. | `number` | `42` | no |
|
||||
| map-3 | n/a | `map` | `{}` | no |
|
||||
| map-2 | It's map number two. | `map` | n/a | yes |
|
||||
| map-1 | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}</pre> | no |
|
||||
| map-1 | It's map number one. | `map` | <pre>{<br/> "a": 1,<br/> "b": 2,<br/> "c": 3<br/>}</pre> | no |
|
||||
| list-3 | n/a | `list` | `[]` | no |
|
||||
| list-2 | It's list number two. | `list` | n/a | yes |
|
||||
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]</pre> | no |
|
||||
| list-1 | It's list number one. | `list` | <pre>[<br/> "a",<br/> "b",<br/> "c"<br/>]</pre> | no |
|
||||
| input_with_underscores | A variable with underscores. | `any` | n/a | yes |
|
||||
| input-with-pipe | It includes v1 \| v2 \| v3 | `string` | `"v1"` | no |
|
||||
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]</pre> | `list` | <pre>[<br> "name rack:location"<br>]</pre> | no |
|
||||
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })</pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}</pre> | no |
|
||||
| input-with-code-block | This is a complicated one. We need a newline.<br/>And an example in a code block<pre>default = [<br/> "machine rack01:neptune"<br/>]</pre> | `list` | <pre>[<br/> "name rack:location"<br/>]</pre> | no |
|
||||
| long_type | This description is itself markdown.<br/><br/>It spans over multiple lines. | <pre>object({<br/> name = string,<br/> foo = object({ foo = string, bar = string }),<br/> bar = object({ foo = string, bar = string }),<br/> fizz = list(string),<br/> buzz = list(string)<br/> })</pre> | <pre>{<br/> "bar": {<br/> "bar": "bar",<br/> "foo": "bar"<br/> },<br/> "buzz": [<br/> "fizz",<br/> "buzz"<br/> ],<br/> "fizz": [],<br/> "foo": {<br/> "bar": "foo",<br/> "foo": "foo"<br/> },<br/> "name": "hello"<br/>}</pre> | no |
|
||||
| no-escape-default-value | The description contains `something_with_underscore`. Defaults to 'VALUE_WITH_UNDERSCORE'. | `string` | `"VALUE_WITH_UNDERSCORE"` | no |
|
||||
| with-url | The description contains url. https://www.domain.com/foo/bar_baz.html | `string` | `""` | no |
|
||||
| string_default_empty | n/a | `string` | `""` | no |
|
||||
|
||||
@@ -22,8 +22,8 @@
|
||||
| list-1 | It's list number one. | `list` |
|
||||
| input_with_underscores | A variable with underscores. | `any` |
|
||||
| input-with-pipe | It includes v1 \| v2 \| v3 | `string` |
|
||||
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]</pre> | `list` |
|
||||
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })</pre> |
|
||||
| input-with-code-block | This is a complicated one. We need a newline.<br/>And an example in a code block<pre>default = [<br/> "machine rack01:neptune"<br/>]</pre> | `list` |
|
||||
| long_type | This description is itself markdown.<br/><br/>It spans over multiple lines. | <pre>object({<br/> name = string,<br/> foo = object({ foo = string, bar = string }),<br/> bar = object({ foo = string, bar = string }),<br/> fizz = list(string),<br/> buzz = list(string)<br/> })</pre> |
|
||||
| no-escape-default-value | The description contains `something_with_underscore`. Defaults to 'VALUE_WITH_UNDERSCORE'. | `string` |
|
||||
| with-url | The description contains url. https://www.domain.com/foo/bar_baz.html | `string` |
|
||||
| string_default_empty | n/a | `string` |
|
||||
|
||||
@@ -16,14 +16,14 @@
|
||||
| number-1 | It's number number one. | `42` |
|
||||
| map-3 | n/a | `{}` |
|
||||
| map-2 | It's map number two. | n/a |
|
||||
| map-1 | It's map number one. | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}</pre> |
|
||||
| map-1 | It's map number one. | <pre>{<br/> "a": 1,<br/> "b": 2,<br/> "c": 3<br/>}</pre> |
|
||||
| list-3 | n/a | `[]` |
|
||||
| list-2 | It's list number two. | n/a |
|
||||
| list-1 | It's list number one. | <pre>[<br> "a",<br> "b",<br> "c"<br>]</pre> |
|
||||
| list-1 | It's list number one. | <pre>[<br/> "a",<br/> "b",<br/> "c"<br/>]</pre> |
|
||||
| input_with_underscores | A variable with underscores. | n/a |
|
||||
| input-with-pipe | It includes v1 \| v2 \| v3 | `"v1"` |
|
||||
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]</pre> | <pre>[<br> "name rack:location"<br>]</pre> |
|
||||
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}</pre> |
|
||||
| input-with-code-block | This is a complicated one. We need a newline.<br/>And an example in a code block<pre>default = [<br/> "machine rack01:neptune"<br/>]</pre> | <pre>[<br/> "name rack:location"<br/>]</pre> |
|
||||
| long_type | This description is itself markdown.<br/><br/>It spans over multiple lines. | <pre>{<br/> "bar": {<br/> "bar": "bar",<br/> "foo": "bar"<br/> },<br/> "buzz": [<br/> "fizz",<br/> "buzz"<br/> ],<br/> "fizz": [],<br/> "foo": {<br/> "bar": "foo",<br/> "foo": "foo"<br/> },<br/> "name": "hello"<br/>}</pre> |
|
||||
| no-escape-default-value | The description contains `something_with_underscore`. Defaults to 'VALUE_WITH_UNDERSCORE'. | `"VALUE_WITH_UNDERSCORE"` |
|
||||
| with-url | The description contains url. https://www.domain.com/foo/bar_baz.html | `""` |
|
||||
| string_default_empty | n/a | `""` |
|
||||
|
||||
Reference in New Issue
Block a user