centersl/terraform-docs
1
0
Fork 0
mirror of https://github.com/terraform-docs/terraform-docs.git synced 2026-03-27 12:58:35 +07:00
Code Issues Packages Projects Releases Wiki Activity

Add option to hide Type and Default columns

Browse Source 
Two new flags are added: '--default bool' and '--type bool' to
control the visibility of Default and Type columns and section
respectively in Markdown and AsciiDoc.

Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
This commit is contained in:
Khosrow Moossavi
2021-03-01 20:22:10 -05:00
parent 7b7a86f962
commit 3d39a94e39
32 changed files with 1513 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/reference/asciidoc-document.md
View File

@@ -27,6 +27,7 @@ terraform-docs asciidoc document [PATH] [flags]
```console
--anchor create anchor links (default true)
-c, --config string config file name (default ".terraform-docs.yml")
--default show Default column or section (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)
@@ -40,6 +41,7 @@ terraform-docs asciidoc document [PATH] [flags]
--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

2
docs/reference/asciidoc-table.md
View File

@@ -27,6 +27,7 @@ terraform-docs asciidoc table [PATH] [flags]
```console
--anchor create anchor links (default true)
-c, --config string config file name (default ".terraform-docs.yml")
--default show Default column or section (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)
@@ -40,6 +41,7 @@ terraform-docs asciidoc table [PATH] [flags]
--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

2
docs/reference/asciidoc.md
View File

@@ -20,10 +20,12 @@ terraform-docs asciidoc [PATH] [flags]
```console
--anchor create anchor links (default true)
--default show Default column or section (default true)
-h, --help help for asciidoc
--indent int indention level of AsciiDoc sections [1, 2, 3, 4, 5] (default 2)
--required show Required column or section (default true)
--sensitive show Sensitive column or section (default true)
--type show Type column or section (default true)
```
## Inherited Options

2
docs/reference/config-file.md
View File

@@ -38,10 +38,12 @@ sort:
settings:
anchors: true
color: true
default: true
escape: true
indent: 2
required: true
sensitive: true
type: true
```
**Note:** The following options cannot be used together:

2
docs/reference/markdown-document.md
View File

@@ -27,6 +27,7 @@ terraform-docs markdown document [PATH] [flags]
```console
--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]
@@ -41,6 +42,7 @@ terraform-docs markdown document [PATH] [flags]
--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

2
docs/reference/markdown-table.md
View File

@@ -27,6 +27,7 @@ terraform-docs markdown table [PATH] [flags]
```console
--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]
@@ -41,6 +42,7 @@ terraform-docs markdown table [PATH] [flags]
--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

2
docs/reference/markdown.md
View File

@@ -20,11 +20,13 @@ terraform-docs markdown [PATH] [flags]
```console
--anchor create anchor links (default true)
--default show Default column or section (default true)
--escape escape special characters (default true)
-h, --help help for markdown
--indent int indention level of Markdown sections [1, 2, 3, 4, 5] (default 2)
--required show Required column or section (default true)
--sensitive show Sensitive column or section (default true)
--type show Type column or section (default true)
```
## Inherited Options