-
Notifications
You must be signed in to change notification settings - Fork 0
/
.terraform-docs.yml
68 lines (56 loc) · 1.4 KB
/
.terraform-docs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# terraform-docs Configuration File
#
# This file (.terraform-docs.yml) is used by default by terraform-docs. It is
# used to generate the README for this Terraform module.
#
# To generate documentation, execute the following:
#
# ```
# terraform-docs .
# ```
#
# See the terraform-docs documentation for more information:
# https://github.com/terraform-docs/terraform-docs/tree/master/docs
formatter: markdown
header-from: main.tf
footer-from: ""
recursive:
enabled: false
path: .
sections:
hide-all: false
hide: [requirements, providers, modules]
show-all: true
show: []
output:
file: "README.md"
mode: replace
template: |-
# AWS Static Website Terraform Module
[![MIT License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/infrable-io/terraform-aws-static-website/blob/master/LICENSE)
[![Maintained by Infrable](https://img.shields.io/badge/Maintained%20by-Infrable-000000)](https://infrable.io)
A Terraform module for creating static websites.
## Terraform Module Documentation
<!-- BEGIN_TF_DOCS -->
{{ .Content }}
<!-- END_TF_DOCS -->
output-values:
enabled: false
from: ""
sort:
enabled: true
by: name
settings:
anchor: true
color: true
default: true
description: false
escape: true
hide-empty: false
html: true
indent: 2
lockfile: true
read-comments: true
required: true
sensitive: true
type: true