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

Link formats documentation in README (#181)

Browse Source 
Co-authored-by: Khosrow Moossavi <khos2ow@gmail.com>
This commit is contained in:
Martyn Ranyard
2020-02-10 19:57:22 +01:00
committed by GitHub
parent 90fd2a322f
commit dafa2e84f7
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -81,25 +81,25 @@ Show help information:
terraform-docs --help
```
Generate JSON from the Terraform configuration in folder `./examples`:
Generate [JSON](docs/formats/json.md) from the Terraform configuration in folder `./examples`:
```bash
terraform-docs json ./examples
```
Generate YAML from the Terraform configuration in folder `./examples`:
Generate [YAML](docs/formats/yaml.md) from the Terraform configuration in folder `./examples`:
```bash
terraform-docs yaml ./examples
```
Generate Markdown tables from the Terraform configuration in folder `./examples`:
Generate [Markdown tables](docs/formats/markdown-table.md) from the Terraform configuration in folder `./examples`:
```bash
terraform-docs markdown table ./examples
```
Generate a Markdown document from the Terraform configuration in folder `./examples`:
Generate a [Markdown document](docs/formats/markdown-document.md) from the Terraform configuration in folder `./examples`:
```bash
terraform-docs markdown document ./examples