Skip to content

Commit e64cd78

Browse files
filipesilvahansl
authored andcommitted
docs: update command descriptions
1 parent 6a7c3d6 commit e64cd78

File tree

4 files changed

+93
-95
lines changed

4 files changed

+93
-95
lines changed

docs/documentation/build.md

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# ng build
44

55
## Overview
6-
`ng build` compiles the application into an output directory
6+
`ng build` compiles the application into an output directory.
77

88
### Creating a build
99

@@ -132,7 +132,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
132132
<details>
133133
<summary>prod</summary>
134134
<p>
135-
<code>--prod</code>
135+
<code>--prod</code>
136136
</p>
137137
<p>
138138
Flag to set configuration to "prod".
@@ -141,7 +141,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
141141
<details>
142142
<summary>configuration</summary>
143143
<p>
144-
<code>--configuration</code> (alias: <code>-c</code>)
144+
<code>--configuration</code> (alias: <code>-c</code>)
145145
</p>
146146
<p>
147147
Specify the configuration to use.
@@ -150,7 +150,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
150150
<details>
151151
<summary>main</summary>
152152
<p>
153-
<code>--main</code>
153+
<code>--main</code>
154154
</p>
155155
<p>
156156
The name of the main entry-point file.
@@ -159,7 +159,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
159159
<details>
160160
<summary>polyfills</summary>
161161
<p>
162-
<code>--polyfills</code>
162+
<code>--polyfills</code>
163163
</p>
164164
<p>
165165
The name of the polyfills file.
@@ -168,7 +168,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
168168
<details>
169169
<summary>ts-config</summary>
170170
<p>
171-
<code>--ts-config</code>
171+
<code>--ts-config</code>
172172
</p>
173173
<p>
174174
The name of the TypeScript configuration file.
@@ -177,7 +177,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
177177
<details>
178178
<summary>optimization</summary>
179179
<p>
180-
<code>--optimization</code>
180+
<code>--optimization</code>
181181
</p>
182182
<p>
183183
Defines the optimization level of the build.
@@ -186,7 +186,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
186186
<details>
187187
<summary>output-path</summary>
188188
<p>
189-
<code>--output-path</code>
189+
<code>--output-path</code>
190190
</p>
191191
<p>
192192
Path where output will be placed.
@@ -195,7 +195,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
195195
<details>
196196
<summary>aot</summary>
197197
<p>
198-
<code>--aot</code>
198+
<code>--aot</code>
199199
</p>
200200
<p>
201201
Build using Ahead of Time compilation.
@@ -204,7 +204,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
204204
<details>
205205
<summary>source-map</summary>
206206
<p>
207-
<code>--source-map</code>
207+
<code>--source-map</code>
208208
</p>
209209
<p>
210210
Output sourcemaps.
@@ -213,7 +213,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
213213
<details>
214214
<summary>eval-source-map</summary>
215215
<p>
216-
<code>--eval-source-map</code>
216+
<code>--eval-source-map</code>
217217
</p>
218218
<p>
219219
Output in-file eval sourcemaps.
@@ -222,7 +222,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
222222
<details>
223223
<summary>vendor-chunk</summary>
224224
<p>
225-
<code>--vendor-chunk</code>
225+
<code>--vendor-chunk</code>
226226
</p>
227227
<p>
228228
Use a separate bundle containing only vendor libraries.
@@ -231,7 +231,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
231231
<details>
232232
<summary>common-chunk</summary>
233233
<p>
234-
<code>--common-chunk</code>
234+
<code>--common-chunk</code>
235235
</p>
236236
<p>
237237
Use a separate bundle containing code used across multiple bundles.
@@ -240,7 +240,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
240240
<details>
241241
<summary>base-href</summary>
242242
<p>
243-
<code>--base-href</code>
243+
<code>--base-href</code>
244244
</p>
245245
<p>
246246
Base url for the application being built.
@@ -249,7 +249,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
249249
<details>
250250
<summary>deploy-url</summary>
251251
<p>
252-
<code>--deploy-url</code>
252+
<code>--deploy-url</code>
253253
</p>
254254
<p>
255255
URL where files will be deployed.
@@ -258,7 +258,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
258258
<details>
259259
<summary>verbose</summary>
260260
<p>
261-
<code>--verbose</code>
261+
<code>--verbose</code>
262262
</p>
263263
<p>
264264
Adds more details to output logging.
@@ -267,7 +267,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
267267
<details>
268268
<summary>progress</summary>
269269
<p>
270-
<code>--progress</code>
270+
<code>--progress</code>
271271
</p>
272272
<p>
273273
Log progress to the console while building.
@@ -276,7 +276,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
276276
<details>
277277
<summary>i18n-file</summary>
278278
<p>
279-
<code>--i18n-file</code>
279+
<code>--i18n-file</code>
280280
</p>
281281
<p>
282282
Localization file to use for i18n.
@@ -285,7 +285,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
285285
<details>
286286
<summary>i18n-format</summary>
287287
<p>
288-
<code>--i18n-format</code>
288+
<code>--i18n-format</code>
289289
</p>
290290
<p>
291291
Format of the localization file specified with --i18n-file.
@@ -294,7 +294,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
294294
<details>
295295
<summary>i18n-locale</summary>
296296
<p>
297-
<code>--i18n-locale</code>
297+
<code>--i18n-locale</code>
298298
</p>
299299
<p>
300300
Locale to use for i18n.
@@ -303,7 +303,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
303303
<details>
304304
<summary>i18n-missing-translation</summary>
305305
<p>
306-
<code>--i18n-missing-translation</code>
306+
<code>--i18n-missing-translation</code>
307307
</p>
308308
<p>
309309
How to handle missing translations for i18n.
@@ -312,7 +312,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
312312
<details>
313313
<summary>extract-css</summary>
314314
<p>
315-
<code>--extract-css</code>
315+
<code>--extract-css</code>
316316
</p>
317317
<p>
318318
Extract css from global styles onto css files instead of js ones.
@@ -321,7 +321,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
321321
<details>
322322
<summary>watch</summary>
323323
<p>
324-
<code>--watch</code>
324+
<code>--watch</code>
325325
</p>
326326
<p>
327327
Run build when files change.
@@ -330,7 +330,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
330330
<details>
331331
<summary>output-hashing</summary>
332332
<p>
333-
<code>--output-hashing</code>
333+
<code>--output-hashing</code>
334334
</p>
335335
<p>
336336
Define the output filename cache-busting hashing mode.
@@ -339,7 +339,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
339339
<details>
340340
<summary>poll</summary>
341341
<p>
342-
<code>--poll</code>
342+
<code>--poll</code>
343343
</p>
344344
<p>
345345
Enable and define the file watching poll time period in milliseconds.
@@ -348,7 +348,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
348348
<details>
349349
<summary>delete-output-path</summary>
350350
<p>
351-
<code>--delete-output-path</code>
351+
<code>--delete-output-path</code>
352352
</p>
353353
<p>
354354
Delete the output path before building.
@@ -357,7 +357,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
357357
<details>
358358
<summary>preserve-symlinks</summary>
359359
<p>
360-
<code>--preserve-symlinks</code>
360+
<code>--preserve-symlinks</code>
361361
</p>
362362
<p>
363363
Do not use the real path when resolving modules.
@@ -366,7 +366,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
366366
<details>
367367
<summary>extract-licenses</summary>
368368
<p>
369-
<code>--extract-licenses</code>
369+
<code>--extract-licenses</code>
370370
</p>
371371
<p>
372372
Extract all licenses in a separate file, in the case of production builds only.
@@ -375,7 +375,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
375375
<details>
376376
<summary>show-circular-dependencies</summary>
377377
<p>
378-
<code>--show-circular-dependencies</code>
378+
<code>--show-circular-dependencies</code>
379379
</p>
380380
<p>
381381
Show circular dependency warnings on builds.
@@ -384,7 +384,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
384384
<details>
385385
<summary>build-optimizer</summary>
386386
<p>
387-
<code>--build-optimizer</code>
387+
<code>--build-optimizer</code>
388388
</p>
389389
<p>
390390
Enables @angular-devkit/build-optimizer optimizations when using the 'aot' option.
@@ -393,7 +393,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
393393
<details>
394394
<summary>named-chunks</summary>
395395
<p>
396-
<code>--named-chunks</code>
396+
<code>--named-chunks</code>
397397
</p>
398398
<p>
399399
Use file name for lazy loaded chunks.
@@ -402,7 +402,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
402402
<details>
403403
<summary>subresource-integrity</summary>
404404
<p>
405-
<code>--subresource-integrity</code>
405+
<code>--subresource-integrity</code>
406406
</p>
407407
<p>
408408
Enables the use of subresource integrity validation.
@@ -411,7 +411,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
411411
<details>
412412
<summary>service-worker</summary>
413413
<p>
414-
<code>--service-worker</code>
414+
<code>--service-worker</code>
415415
</p>
416416
<p>
417417
Generates a service worker config for production builds.
@@ -420,7 +420,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
420420
<details>
421421
<summary>ngsw-config-path</summary>
422422
<p>
423-
<code>--ngsw-config-path</code>
423+
<code>--ngsw-config-path</code>
424424
</p>
425425
<p>
426426
Path to ngsw-config.json.
@@ -429,7 +429,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
429429
<details>
430430
<summary>skip-app-shell</summary>
431431
<p>
432-
<code>--skip-app-shell</code>
432+
<code>--skip-app-shell</code>
433433
</p>
434434
<p>
435435
Flag to prevent building an app shell.
@@ -438,7 +438,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
438438
<details>
439439
<summary>index</summary>
440440
<p>
441-
<code>--index</code>
441+
<code>--index</code>
442442
</p>
443443
<p>
444444
The name of the index HTML file.
@@ -447,7 +447,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
447447
<details>
448448
<summary>stats-json</summary>
449449
<p>
450-
<code>--stats-json</code>
450+
<code>--stats-json</code>
451451
</p>
452452
<p>
453453
Generates a 'stats.json' file which can be analyzed using tools such as: #webpack-bundle-analyzer' or https: //webpack.github.io/analyse.
@@ -456,7 +456,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
456456
<details>
457457
<summary>fork-type-checker</summary>
458458
<p>
459-
<code>--fork-type-checker</code>
459+
<code>--fork-type-checker</code>
460460
</p>
461461
<p>
462462
Run the TypeScript type checker in a forked process.

0 commit comments

Comments
 (0)