Skip to content

Commit 45675ab

Browse files
Retool config page documentation
1 parent 653f20e commit 45675ab

File tree

2 files changed

+42
-32
lines changed

2 files changed

+42
-32
lines changed

_includes/param-list.html

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
Default value: <code>null</code>
66
</td>
77
<td>
8-
<code class="option">path: &lt;path&gt;</code>
8+
<code class="flag">--path=&lt;path&gt;</code>
99
</td>
1010
<td>
11-
<code class="flag">--path=&lt;path&gt;</code>
11+
<code class="option">path: &lt;path&gt;</code>
1212
</td>
1313
</tr>
1414
<tr>
@@ -18,10 +18,10 @@
1818
Default value: <code>null</code>
1919
</td>
2020
<td>
21-
<code class="option">ssh: &lt;ssh&gt;</code>
21+
<code class="flag">--ssh=&lt;ssh&gt;</code>
2222
</td>
2323
<td>
24-
<code class="flag">--ssh=&lt;ssh&gt;</code>
24+
<code class="option">ssh: &lt;ssh&gt;</code>
2525
</td>
2626
</tr>
2727
<tr>
@@ -31,10 +31,10 @@
3131
Default value: <code>null</code>
3232
</td>
3333
<td>
34-
<code class="option">http: &lt;http&gt;</code>
34+
<code class="flag">--http=&lt;http&gt;</code>
3535
</td>
3636
<td>
37-
<code class="flag">--http=&lt;http&gt;</code>
37+
<code class="option">http: &lt;http&gt;</code>
3838
</td>
3939
</tr>
4040
<tr>
@@ -44,10 +44,10 @@
4444
Default value: <code>null</code>
4545
</td>
4646
<td>
47-
<code class="option">url: &lt;url&gt;</code>
47+
<code class="flag">--url=&lt;url&gt;</code>
4848
</td>
4949
<td>
50-
<code class="flag">--url=&lt;url&gt;</code>
50+
<code class="option">url: &lt;url&gt;</code>
5151
</td>
5252
</tr>
5353
<tr>
@@ -57,10 +57,10 @@
5757
Default value: <code>null</code>
5858
</td>
5959
<td>
60-
<code class="option">user: &lt;id|login|email&gt;</code>
60+
<code class="flag">--user=&lt;id|login|email&gt;</code>
6161
</td>
6262
<td>
63-
<code class="flag">--user=&lt;id|login|email&gt;</code>
63+
<code class="option">user: &lt;id|login|email&gt;</code>
6464
</td>
6565
</tr>
6666
<tr>
@@ -70,10 +70,10 @@
7070
Default value: <code>&quot;&quot;</code>
7171
</td>
7272
<td>
73-
<code class="option">skip-plugins: &lt;list&gt;</code>
73+
<code class="flag">--skip-plugins[=&lt;plugin&gt;]</code>
7474
</td>
7575
<td>
76-
<code class="flag">--skip-plugins[=&lt;plugin&gt;]</code>
76+
<code class="option">skip-plugins: &lt;list&gt;</code>
7777
</td>
7878
</tr>
7979
<tr>
@@ -83,10 +83,10 @@
8383
Default value: <code>&quot;&quot;</code>
8484
</td>
8585
<td>
86-
<code class="option">skip-themes: &lt;list&gt;</code>
86+
<code class="flag">--skip-themes[=&lt;theme&gt;]</code>
8787
</td>
8888
<td>
89-
<code class="flag">--skip-themes[=&lt;theme&gt;]</code>
89+
<code class="option">skip-themes: &lt;list&gt;</code>
9090
</td>
9191
</tr>
9292
<tr>
@@ -96,10 +96,10 @@
9696
Default value: <code>false</code>
9797
</td>
9898
<td>
99-
<code class="option">skip-packages: &lt;bool&gt;</code>
99+
<code class="flag">--skip-packages</code>
100100
</td>
101101
<td>
102-
<code class="flag">--skip-packages</code>
102+
<code class="option">skip-packages: &lt;bool&gt;</code>
103103
</td>
104104
</tr>
105105
<tr>
@@ -109,10 +109,10 @@
109109
Default value: <code>[]</code>
110110
</td>
111111
<td>
112-
<code class="option">require: &lt;path&gt;</code>
112+
<code class="flag">--require=&lt;path&gt;</code>
113113
</td>
114114
<td>
115-
<code class="flag">--require=&lt;path&gt;</code>
115+
<code class="option">require: &lt;path&gt;</code>
116116
</td>
117117
</tr>
118118
<tr>
@@ -122,10 +122,10 @@
122122
Default value: <code>[]</code>
123123
</td>
124124
<td>
125-
<code class="option">disabled_commands: &lt;list&gt;</code>
125+
<em>Not available as a flag</em>
126126
</td>
127127
<td>
128-
<code class="flag"></code>
128+
<code class="option">disabled_commands: &lt;list&gt;</code>
129129
</td>
130130
</tr>
131131
<tr>
@@ -135,10 +135,10 @@
135135
Default value: <code>&quot;auto&quot;</code>
136136
</td>
137137
<td>
138-
<code class="option">color: &lt;bool&gt;</code>
138+
<code class="flag">--[no-]color</code>
139139
</td>
140140
<td>
141-
<code class="flag">--[no-]color</code>
141+
<code class="option">color: &lt;bool&gt;</code>
142142
</td>
143143
</tr>
144144
<tr>
@@ -148,10 +148,10 @@
148148
Default value: <code>false</code>
149149
</td>
150150
<td>
151-
<code class="option">debug: &lt;group&gt;</code>
151+
<code class="flag">--debug[=&lt;group&gt;]</code>
152152
</td>
153153
<td>
154-
<code class="flag">--debug[=&lt;group&gt;]</code>
154+
<code class="option">debug: &lt;group&gt;</code>
155155
</td>
156156
</tr>
157157
<tr>
@@ -161,10 +161,10 @@
161161
Default value: <code>false</code>
162162
</td>
163163
<td>
164-
<code class="option"></code>
164+
<code class="flag">--prompt</code>
165165
</td>
166166
<td>
167-
<code class="flag">--prompt</code>
167+
<em>Not available as an option</em>
168168
</td>
169169
</tr>
170170
<tr>
@@ -174,10 +174,10 @@
174174
Default value: <code>false</code>
175175
</td>
176176
<td>
177-
<code class="option">quiet: &lt;bool&gt;</code>
177+
<code class="flag">--quiet</code>
178178
</td>
179179
<td>
180-
<code class="flag">--quiet</code>
180+
<code class="option">quiet: &lt;bool&gt;</code>
181181
</td>
182182
</tr>
183183
<tr>
@@ -187,9 +187,9 @@
187187
Default value: <code>[]</code>
188188
</td>
189189
<td>
190-
<code class="option">apache_modules: &lt;list&gt;</code>
190+
<em>Not available as a flag</em>
191191
</td>
192192
<td>
193-
<code class="flag"></code>
193+
<code class="option">apache_modules: &lt;list&gt;</code>
194194
</td>
195195
</tr>

_templates/config.mustache

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,19 @@
55
Default value: <code>{{default}}</code>
66
</td>
77
<td>
8-
<code class="option">{{config}}</code>
8+
{{#flag}}
9+
<code class="flag">{{flag}}</code>
10+
{{/flag}}
11+
{{^flag}}
12+
<em>Not available as a flag</em>
13+
{{/flag}}
914
</td>
1015
<td>
11-
<code class="flag">{{flag}}</code>
16+
{{#config}}
17+
<code class="option">{{config}}</code>
18+
{{/config}}
19+
{{^config}}
20+
<em>Not available as an option</em>
21+
{{/config}}
1222
</td>
1323
</tr>

0 commit comments

Comments
 (0)