Skip to content

Commit 7069f13

Browse files
clydinfilipesilva
clydin
authored and
filipesilva
committed
docs: update wiki command documentation
1 parent 02274c7 commit 7069f13

21 files changed

+788
-167
lines changed

‎docs/documentation/config.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ If both the `[key]` and `[value]` are provided it will set the value.
1212
<details>
1313
<summary>global</summary>
1414
<p>
15-
<code>--global</code> (alias: <code>-g</code>)
15+
<code>--global</code> (alias: <code>-g</code>)
1616
</p>
1717
<p>
1818
Get/set the value in the global configuration (in your home directory).

‎docs/documentation/doc.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<details>
1010
<summary>search</summary>
1111
<p>
12-
<code>--search</code> (alias: <code>-s</code>)
12+
<code>--search</code> (alias: <code>-s</code>)
1313
</p>
1414
<p>
1515
Search whole angular.io instead of just api.

‎docs/documentation/eject.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<!-- Links in /docs/documentation should NOT have \`.md\` at the end, because they end up in our wiki at release. -->
2+
3+
# ng eject
4+
5+
## Overview
6+
Temporarily disabled. Ejects your app and output the proper webpack configuration and scripts.
7+
8+
## Options
9+
None.

‎docs/documentation/generate.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
<details>
2121
<summary>dry-run</summary>
2222
<p>
23-
<code>--dry-run</code> (alias: <code>-d</code>)
23+
<code>--dry-run</code> (alias: <code>-d</code>)
2424
</p>
2525
<p>
2626
Run through without making any changes.
@@ -29,7 +29,7 @@
2929
<details>
3030
<summary>force</summary>
3131
<p>
32-
<code>--force</code> (alias: <code>-f</code>)
32+
<code>--force</code> (alias: <code>-f</code>)
3333
</p>
3434
<p>
3535
Forces overwriting of files.

‎docs/documentation/generate/app-shell.md‎

Lines changed: 170 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
1+
<!-- Links in /docs/documentation should NOT have \`.md\` at the end, because they end up in our wiki at release. -->
2+
3+
# ng generate app-shell
4+
5+
## Overview
6+
Create an app shell.
7+
8+
## Options
9+
<details>
10+
<summary>dry-run</summary>
11+
<p>
12+
<code>--dry-run</code> (alias: <code>-d</code>)
13+
</p>
14+
<p>
15+
Run through without making any changes.
16+
</p>
17+
</details>
18+
<details>
19+
<summary>force</summary>
20+
<p>
21+
<code>--force</code> (alias: <code>-f</code>)
22+
</p>
23+
<p>
24+
Forces overwriting of files.
25+
</p>
26+
</details>
27+
<details>
28+
<summary>client-project</summary>
29+
<p>
30+
<code>--client-project</code>
31+
</p>
32+
<p>
33+
Name of related client app.
34+
</p>
35+
</details>
36+
<details>
37+
<summary>universal-project</summary>
38+
<p>
39+
<code>--universal-project</code>
40+
</p>
41+
<p>
42+
Name of related universal app.
43+
</p>
44+
</details>
45+
<details>
46+
<summary>route</summary>
47+
<p>
48+
<code>--route</code>
49+
</p>
50+
<p>
51+
Route path used to produce the app shell.
52+
</p>
53+
</details>
54+
<details>
55+
<summary>name</summary>
56+
<p>
57+
<code>--name</code>
58+
</p>
59+
<p>
60+
Name of the universal app
61+
</p>
62+
</details>
63+
<details>
64+
<summary>app-id</summary>
65+
<p>
66+
<code>--app-id</code>
67+
</p>
68+
<p>
69+
The appId to use withServerTransition.
70+
</p>
71+
</details>
72+
<details>
73+
<summary>out-dir</summary>
74+
<p>
75+
<code>--out-dir</code>
76+
</p>
77+
<p>
78+
The output directory for build results.
79+
</p>
80+
</details>
81+
<details>
82+
<summary>root</summary>
83+
<p>
84+
<code>--root</code>
85+
</p>
86+
<p>
87+
The root directory of the app.
88+
</p>
89+
</details>
90+
<details>
91+
<summary>index</summary>
92+
<p>
93+
<code>--index</code>
94+
</p>
95+
<p>
96+
Name of the index file
97+
</p>
98+
</details>
99+
<details>
100+
<summary>main</summary>
101+
<p>
102+
<code>--main</code>
103+
</p>
104+
<p>
105+
The name of the main entry-point file.
106+
</p>
107+
</details>
108+
<details>
109+
<summary>test</summary>
110+
<p>
111+
<code>--test</code>
112+
</p>
113+
<p>
114+
The name of the test entry-point file.
115+
</p>
116+
</details>
117+
<details>
118+
<summary>tsconfig-file-name</summary>
119+
<p>
120+
<code>--tsconfig-file-name</code>
121+
</p>
122+
<p>
123+
The name of the TypeScript configuration file.
124+
</p>
125+
</details>
126+
<details>
127+
<summary>test-tsconfig-file-name</summary>
128+
<p>
129+
<code>--test-tsconfig-file-name</code>
130+
</p>
131+
<p>
132+
The name of the TypeScript configuration file for tests.
133+
</p>
134+
</details>
135+
<details>
136+
<summary>app-dir</summary>
137+
<p>
138+
<code>--app-dir</code>
139+
</p>
140+
<p>
141+
The name of the application directory.
142+
</p>
143+
</details>
144+
<details>
145+
<summary>root-module-file-name</summary>
146+
<p>
147+
<code>--root-module-file-name</code>
148+
</p>
149+
<p>
150+
The name of the root module file
151+
</p>
152+
</details>
153+
<details>
154+
<summary>root-module-class-name</summary>
155+
<p>
156+
<code>--root-module-class-name</code>
157+
</p>
158+
<p>
159+
The name of the root module class.
160+
</p>
161+
</details>
162+
<details>
163+
<summary>source-dir</summary>
164+
<p>
165+
<code>--source-dir</code> (alias: <code>-D</code>)
166+
</p>
167+
<p>
168+
The path of the source directory.
169+
</p>
170+
</details>

‎docs/documentation/generate/application.md‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
<!-- Links in /docs/documentation should NOT have \`.md\` at the end, because they end up in our wiki at release. -->
2+
3+
# ng generate application
4+
5+
## Overview
6+
Create an Angular application.
7+
8+
## Options
9+
<details>
10+
<summary>dry-run</summary>
11+
<p>
12+
<code>--dry-run</code> (alias: <code>-d</code>)
13+
</p>
14+
<p>
15+
Run through without making any changes.
16+
</p>
17+
</details>
18+
<details>
19+
<summary>force</summary>
20+
<p>
21+
<code>--force</code> (alias: <code>-f</code>)
22+
</p>
23+
<p>
24+
Forces overwriting of files.
25+
</p>
26+
</details>
27+
<details>
28+
<summary>inline-style</summary>
29+
<p>
30+
<code>--inline-style</code> (alias: <code>-s</code>)
31+
</p>
32+
<p>
33+
Specifies if the style will be in the ts file.
34+
</p>
35+
</details>
36+
<details>
37+
<summary>inline-template</summary>
38+
<p>
39+
<code>--inline-template</code> (alias: <code>-t</code>)
40+
</p>
41+
<p>
42+
Specifies if the template will be in the ts file.
43+
</p>
44+
</details>
45+
<details>
46+
<summary>view-encapsulation</summary>
47+
<p>
48+
<code>--view-encapsulation</code>
49+
</p>
50+
<p>
51+
Specifies the view encapsulation strategy.
52+
</p>
53+
</details>
54+
<details>
55+
<summary>routing</summary>
56+
<p>
57+
<code>--routing</code>
58+
</p>
59+
<p>
60+
Generates a routing module.
61+
</p>
62+
</details>
63+
<details>
64+
<summary>prefix</summary>
65+
<p>
66+
<code>--prefix</code> (alias: <code>-p</code>)
67+
</p>
68+
<p>
69+
The prefix to apply to generated selectors.
70+
</p>
71+
</details>
72+
<details>
73+
<summary>style</summary>
74+
<p>
75+
<code>--style</code>
76+
</p>
77+
<p>
78+
The file extension to be used for style files.
79+
</p>
80+
</details>
81+
<details>
82+
<summary>skip-tests</summary>
83+
<p>
84+
<code>--skip-tests</code> (alias: <code>-S</code>)
85+
</p>
86+
<p>
87+
Skip creating spec files.
88+
</p>
89+
</details>
90+
<details>
91+
<summary>skip-package-json</summary>
92+
<p>
93+
<code>--skip-package-json</code>
94+
</p>
95+
<p>
96+
Do not add dependencies to package.json.
97+
</p>
98+
</details>

‎docs/documentation/generate/class.md‎

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,32 @@
77

88
## Options
99
<details>
10-
<summary>app</summary>
10+
<summary>dry-run</summary>
1111
<p>
12-
<code>--app</code> (aliases: <code>-a</code>) <em>default value: 1st app</em>
12+
<code>--dry-run</code> (alias: <code>-d</code>)
1313
</p>
1414
<p>
15-
Specifies app name to use.
15+
Run through without making any changes.
16+
</p>
17+
</details>
18+
<details>
19+
<summary>force</summary>
20+
<p>
21+
<code>--force</code> (alias: <code>-f</code>)
22+
</p>
23+
<p>
24+
Forces overwriting of files.
25+
</p>
26+
</details>
27+
<details>
28+
<summary>project</summary>
29+
<p>
30+
<code>--project</code>
31+
</p>
32+
<p>
33+
The name of the project.
1634
</p>
1735
</details>
18-
1936
<details>
2037
<summary>spec</summary>
2138
<p>
@@ -25,3 +42,12 @@
2542
Specifies if a spec file is generated.
2643
</p>
2744
</details>
45+
<details>
46+
<summary>type</summary>
47+
<p>
48+
<code>--type</code>
49+
</p>
50+
<p>
51+
Specifies the type of class.
52+
</p>
53+
</details>

0 commit comments

Comments
 (0)