Skip to content

Commit 1fa5f2d

Browse files
sumitarorahansl
sumitarora
authored and
hansl
committed
docs: fixing lint documentation (angular#5633)
Fixes angular#5632 Fixes angular#5713
1 parent d73c739 commit 1fa5f2d

18 files changed

Lines changed: 209 additions & 153 deletions

File tree

‎docs/documentation/build.md‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ or `ng serve --prod` will also make use of uglifying and tree-shaking functional
6868
<details>
6969
<summary>aot</summary>
7070
<p>
71-
`--aot` _default: false_
71+
<code>--aot</code> <em>default value: false</em>
7272
</p>
7373
<p>
7474
Build using Ahead of Time compilation.
@@ -78,7 +78,7 @@ or `ng serve --prod` will also make use of uglifying and tree-shaking functional
7878
<details>
7979
<summary>app</summary>
8080
<p>
81-
`--app` (aliases: `-a`)
81+
<code>--app</code> (aliases: <code>-a</code>)
8282
</p>
8383
<p>
8484
Specifies app name or index to use.
@@ -88,7 +88,7 @@ or `ng serve --prod` will also make use of uglifying and tree-shaking functional
8888
<details>
8989
<summary>base-href</summary>
9090
<p>
91-
`--base-href` (aliases: `-bh`)
91+
<code>--base-href</code> (aliases: <code>-bh</code>)
9292
</p>
9393
<p>
9494
Base url for the application being built.
@@ -98,7 +98,7 @@ or `ng serve --prod` will also make use of uglifying and tree-shaking functional
9898
<details>
9999
<summary>deploy-url</summary>
100100
<p>
101-
`--deploy-url` (aliases: `-d`)
101+
<code>--deploy-url</code> (aliases: <code>-d</code>)
102102
</p>
103103
<p>
104104
URL where files will be deployed.
@@ -108,7 +108,7 @@ or `ng serve --prod` will also make use of uglifying and tree-shaking functional
108108
<details>
109109
<summary>output-path</summary>
110110
<p>
111-
`--output-path` (aliases: `-op`)
111+
<code>--output-path</code> (aliases: <code>-op</code>)
112112
</p>
113113
<p>
114114
Path where output will be placed
@@ -118,7 +118,7 @@ or `ng serve --prod` will also make use of uglifying and tree-shaking functional
118118
<details>
119119
<summary>environment</summary>
120120
<p>
121-
`--environment` (aliases: `-e`)
121+
<code>--environment</code> (aliases: <code>-e</code>)
122122
</p>
123123
<p>
124124
Defines the build environment.
@@ -128,7 +128,7 @@ or `ng serve --prod` will also make use of uglifying and tree-shaking functional
128128
<details>
129129
<summary>extract-css</summary>
130130
<p>
131-
`--extract-css` (aliases: `-ec`)
131+
<code>--extract-css</code> (aliases: <code>-ec</code>)
132132
</p>
133133
<p>
134134
Extract css from global styles onto css files instead of js ones.
@@ -138,7 +138,7 @@ or `ng serve --prod` will also make use of uglifying and tree-shaking functional
138138
<details>
139139
<summary>i18n-file</summary>
140140
<p>
141-
`--i18n-file`
141+
<code>--i18n-file</code>
142142
</p>
143143
<p>
144144
Localization file to use for i18n.
@@ -148,7 +148,7 @@ or `ng serve --prod` will also make use of uglifying and tree-shaking functional
148148
<details>
149149
<summary>i18n-format</summary>
150150
<p>
151-
`--i18n-format`
151+
<code>--i18n-format</code>
152152
</p>
153153
<p>
154154
Format of the localization file specified with --i18n-file.
@@ -158,7 +158,7 @@ or `ng serve --prod` will also make use of uglifying and tree-shaking functional
158158
<details>
159159
<summary>locale</summary>
160160
<p>
161-
`--locale`
161+
<code>--locale</code>
162162
</p>
163163
<p>
164164
Locale to use for i18n.
@@ -168,20 +168,20 @@ or `ng serve --prod` will also make use of uglifying and tree-shaking functional
168168
<details>
169169
<summary>output-hashing</summary>
170170
<p>
171-
`--output-hashing` (aliases: `-oh`)
171+
<code>--output-hashing</code> (aliases: <code>-oh</code>)
172172
</p>
173173
<p>
174174
Define the output filename cache-busting hashing mode.
175175
</p>
176176
<p>
177-
Values: `none`, `all`, `media`, `bundles`
177+
Values: <code>none</code>, <code>all</code>, <code>media</code>, <code>bundles</code>
178178
</p>
179179
</details>
180180

181181
<details>
182182
<summary>output-path</summary>
183183
<p>
184-
`--output-path` (aliases: `-op`)
184+
<code>--output-path</code> (aliases: <code>-op</code>)
185185
</p>
186186
<p>
187187
Path where output will be placed.
@@ -191,7 +191,7 @@ or `ng serve --prod` will also make use of uglifying and tree-shaking functional
191191
<details>
192192
<summary>poll</summary>
193193
<p>
194-
`--poll`
194+
<code>--poll</code>
195195
</p>
196196
<p>
197197
Enable and define the file watching poll time period (milliseconds).
@@ -201,7 +201,7 @@ or `ng serve --prod` will also make use of uglifying and tree-shaking functional
201201
<details>
202202
<summary>progress</summary>
203203
<p>
204-
`--progress` (aliases: `-pr`) _default value: true_
204+
<code>--progress</code> (aliases: <code>-pr</code>) <em>default value: true</<em>
205205
</p>
206206
<p>
207207
Log progress to the console while building.
@@ -211,7 +211,7 @@ or `ng serve --prod` will also make use of uglifying and tree-shaking functional
211211
<details>
212212
<summary>sourcemap</summary>
213213
<p>
214-
`--sourcemap` (aliases: `-sm`, `sourcemaps`)
214+
<code>--sourcemap</code> (aliases: <code>-sm</code>, <code>sourcemaps</code>)
215215
</p>
216216
<p>
217217
Output sourcemaps.
@@ -221,17 +221,17 @@ or `ng serve --prod` will also make use of uglifying and tree-shaking functional
221221
<details>
222222
<summary>stats-json</summary>
223223
<p>
224-
`--stats-json` (aliases: `-`)
224+
<code>--stats-json</code>
225225
</p>
226226
<p>
227-
Generates a `stats.json` file which can be analyzed using tools such as: `webpack-bundle-analyzer` or https://webpack.github.io/analyse.
227+
Generates a <code>stats.json</code> file which can be analyzed using tools such as: <code>webpack-bundle-analyzer</code> or https://webpack.github.io/analyse.
228228
</p>
229229
</details>
230230

231231
<details>
232232
<summary>target</summary>
233233
<p>
234-
`--target` (aliases: `-t`, `-dev`, `-prod`) _default value: development_
234+
<code>--target</code> (aliases: <code>-t</code>, <code>-dev</code>, <code>-prod</code>) <em>default value: development</em>
235235
</p>
236236
<p>
237237
Defines the build target.
@@ -241,7 +241,7 @@ or `ng serve --prod` will also make use of uglifying and tree-shaking functional
241241
<details>
242242
<summary>vendor-chunk</summary>
243243
<p>
244-
`--vendor-chunk` (aliases: `-vc`) _default value: true_
244+
<code>--vendor-chunk</code> (aliases: <code>-vc</code>) <em>default value: true</em>
245245
</p>
246246
<p>
247247
Use a separate bundle containing only vendor libraries.
@@ -251,7 +251,7 @@ or `ng serve --prod` will also make use of uglifying and tree-shaking functional
251251
<details>
252252
<summary>verbose</summary>
253253
<p>
254-
`--verbose` (aliases: `-v`) _default value: false_
254+
<code>--verbose</code> (aliases: <code>-v</code>) <em>default value: false</em>
255255
</p>
256256
<p>
257257
Adds more details to output logging.
@@ -261,7 +261,7 @@ or `ng serve --prod` will also make use of uglifying and tree-shaking functional
261261
<details>
262262
<summary>watch</summary>
263263
<p>
264-
`--watch` (aliases: `-w`)
264+
<code>--watch</code> (aliases: <code>-w</code>)
265265
</p>
266266
<p>
267267
Run build when files change.

‎docs/documentation/config.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<details>
1010
<summary>global</summary>
1111
<p>
12-
`--global` _default value: false_
12+
<code>--global</code> <em>default value: false</em>
1313
</p>
1414
<p>
1515
Get the value in the global configuration (in your home directory).
@@ -26,7 +26,7 @@
2626
<details>
2727
<summary>global</summary>
2828
<p>
29-
`--global` _default value: false_
29+
<code>--global</code> <em>default value: false</em>
3030
</p>
3131
<p>
3232
Get the value in the global configuration (in your home directory).

‎docs/documentation/e2e.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ End-to-end tests are run via [Protractor] (https://angular.github.io/protractor/
1717
<details>
1818
<summary>config</summary>
1919
<p>
20-
`--config` (alias: `-c`)
20+
<code>--config</code> (aliases: <code>-c</code>)
2121
</p>
2222
<p>
2323
Use a specific config file. Defaults to the protractor config file in `.angular-cli.json`.
@@ -27,7 +27,7 @@ End-to-end tests are run via [Protractor] (https://angular.github.io/protractor/
2727
<details>
2828
<summary>element-explorer</summary>
2929
<p>
30-
`--element-explorer` (alias: `-ee`) _default value: false_
30+
<code>--element-explorer</code> (aliases: <code>-ee</code>) <em>default value: false</em>
3131
</p>
3232
<p>
3333
Start Protractor's [Element Explorer](https://github.com/angular/protractor/blob/master/docs/debugging.md#testing-out-protractor-interactively) for debugging.
@@ -37,7 +37,7 @@ End-to-end tests are run via [Protractor] (https://angular.github.io/protractor/
3737
<details>
3838
<summary>serve</summary>
3939
<p>
40-
`--serve` (alias: `-s`) _default value: true_
40+
<code>--serve</code> (aliases: <code>-s</code>) <em>default value: true</em>
4141
</p>
4242
<p>
4343
Compile and Serve the app. All serve options are also available. The live-reload option defaults to false, and the default port will be random.
@@ -47,7 +47,7 @@ End-to-end tests are run via [Protractor] (https://angular.github.io/protractor/
4747
<details>
4848
<summary>specs</summary>
4949
<p>
50-
`--specs` (alias: `-sp`) _default value: []_
50+
<code>--specs</code> (aliases: <code>-sp</code>) <em>default value: []</em>
5151
</p>
5252
<p>
5353
Override specs in the protractor config. Can send in multiple specs by repeating flag (ng e2e --specs=spec1.ts --specs=spec2.ts).
@@ -57,7 +57,7 @@ End-to-end tests are run via [Protractor] (https://angular.github.io/protractor/
5757
<details>
5858
<summary>webdrive-update</summary>
5959
<p>
60-
`--webdrive-update` (alias: `-wu`) _default value: true_
60+
<code>--webdrive-update</code> (aliases: <code>-wu</code>) <em>default value: true</em>
6161
</p>
6262
<p>
6363
Try to update webdriver.

0 commit comments

Comments
 (0)