Skip to content

Commit dee9499

Browse files
authored
Updated Readme Formatting
1 parent 9112c84 commit dee9499

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -87,60 +87,60 @@ context:
8787
cognitoPoolID: xxx
8888
modules:
8989
- source: "github.com/zthomas/commit0-terraform-basic"
90-
output: "infrastructure"
91-
- source: "github.com/zthomas/react-mui-kit"
92-
output: "web-app"
90+
output: "infrastructure"
91+
- source: "github.com/zthomas/react-mui-kit"
92+
output: "web-app"
9393
```
9494

95-
## name<a name="name"></a>
95+
## Name<a name="name"></a>
9696
Name of your project. This will be used to name the github repos as well as in other parts of the generated code.
9797

9898
[]() | |
9999
--- | ---
100100
Required | True
101101
Type | String
102102

103-
## context<a name="context"></a>
103+
## Context<a name="context"></a>
104104
A key value map of global context parameters to use in the templates.
105105

106106
[]() | |
107107
--- | ---
108108
Required | False
109109
Type | Map[String]
110110

111-
## modules<a name="modules"></a>
111+
## Modules<a name="modules"></a>
112112
List of modules template modules to import
113113

114114
[]() | |
115115
--- | ---
116116
Required | True
117117
Type | Map[Module]
118118

119-
## source<a name="module-source"></a>
119+
## Source<a name="module-source"></a>
120120
We are using go-getter to parse the sources, we you can use any URL or file formats that [go-getter](https://github.com/hashicorp/go-getter#url-format) supports.
121121

122122
[]() | |
123123
--- | ---
124124
Required | True
125125
Type | String
126126

127-
## module<a name="module-params"></a>
127+
## Params<a name="module-params"></a>
128128
Module parameters to use during templating
129129

130130
[]() | |
131131
--- | ---
132132
Required | True
133133
Type | String
134134

135-
## output<a name="module-output"></a>
135+
## Output<a name="module-output"></a>
136136
Template output directory that the current module should write to.
137137

138138
[]() | |
139139
--- | ---
140140
Required | False
141141
Type | String
142142

143-
## output<a name="module-overwrite"></a>
143+
## Overwrite<a name="module-overwrite"></a>
144144
Whether to overwrite existing files when generating files from templates
145145

146146
[]() | |
@@ -163,15 +163,15 @@ template:
163163
output: web-app
164164
```
165165

166-
## name<a name="module-name"></a>
166+
## Name<a name="module-name"></a>
167167
Name of your module. This will be used as the default module directory as well as a display name in the prompts.
168168

169169
[]() | |
170170
--- | ---
171171
Required | True
172172
Type | String
173173

174-
## description<a name="module-description"></a>
174+
## Description<a name="module-description"></a>
175175
Short description of the module
176176

177177
[]() | |
@@ -186,23 +186,23 @@ Template configurations
186186
Required | False
187187
Type | Map
188188

189-
## extension<a name="template-extension"></a>
189+
## Extension<a name="template-extension"></a>
190190
File extension to signify that a file is a template. If this is defined, non-template files will not be parsed and will be copied over directly. The default value is `.tmplt`
191191

192192
[]() | |
193193
--- | ---
194194
Required | False
195195
Type | Map
196196

197-
## delimiters<a name="template-delimiters"></a>
197+
## Delimiters<a name="template-delimiters"></a>
198198
An pair of delimiters that the template engine should use. The default values are: `{{`, `}}`
199199

200200
[]() | |
201201
--- | ---
202202
Required | False
203203
Type | Map[String]
204204

205-
## output<a name="template-output"></a>
205+
## Output<a name="template-output"></a>
206206
The default template output directory that you want the template engine to write to. This will be overwritten by the
207207

208208
[]() | |
@@ -233,7 +233,7 @@ The message that will be presented to the user
233233
Required | False
234234
Type | String
235235

236-
## options<a name="prompt-label"></a>
236+
## Options<a name="prompt-options"></a>
237237
A list of options to select from. If not given, then it will be rendered as a text input prompt.
238238

239239
[]() | |

0 commit comments

Comments
 (0)