You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In silent mode log messages are suppressed and error messages are sanitized.
233
+
In silent mode, log messages are suppressed and error messages are sanitized.
234
234
235
235
The `--no-silent` option enables extended console logging.
236
236
Keep this untouched if the repository URL or other information passed to git commands is sensitive!
237
237
238
-
> WARNING: This option should kept like it is if the repository URL or other information passed to git commands is sensitive and should not be logged (== you have a public build server and you are using the `GH_TOKEN` feature).
238
+
> WARNING: This option should be kept as it is if the repository URL or other information passed to Git commands is sensitive and should not be logged (== you have a public build server and you are using the `GH_TOKEN` feature).
239
239
> By default the silent mode is enabled to avoid sensitive data exposure.
240
240
241
241
@@ -250,39 +250,39 @@ The command includes dotfiles by default (e.g `.htaccess` will be committed)
250
250
With `--no-dotfiles` files starting with `.` are ignored.
251
251
252
252
**Hint:**
253
-
This is super usefull if you want to publish a `.nojekyll` file.
254
-
Create such a file in the root of your pages repo to bypass the Jekyll static site generator on Github Pages.
255
-
Static content is still delivered – even without Jekyll.
253
+
This is super useful if you want to publish a `.nojekyll` file.
254
+
Create such a file in the root of your pages repo to bypass the Jekyll static site generator on GitHub Pages.
255
+
Static content is still delivered -- even without Jekyll.
256
256
This should only be necessary if your site uses files or directories that start with **_underscores** since Jekyll considers these to be special resources and does not copy them to the final site.
257
257
→ Or just don't use underscores!
258
258
259
259
260
260
#### --cname <aname="cname"></a>
261
261
*__optional__
262
-
* Default: `undefined` (string) – No CNAME file is generated
262
+
* Default: `undefined` (string) -- No CNAME file is generated
263
263
* Example:
264
264
*`ng deploy --cname=example.com`
265
265
266
266
A CNAME file will be created enabling you to use a custom domain.
267
-
[More information on Github Pages using a custom domain](https://help.github.com/articles/using-a-custom-domain-with-github-pages/).
267
+
[More information on GitHub Pages using a custom domain](https://help.github.com/articles/using-a-custom-domain-with-github-pages/).
268
268
269
269
270
270
#### --dry-run <aname="dry-run"></a>
271
271
*__optional__
272
272
* Default: `false` (boolean)
273
273
* Example:
274
-
*`ng deploy` -- Normal behaviour: Changes are applied.
274
+
*`ng deploy` -- Normal behavior: Changes are applied.
275
275
*`ng deploy --dry-run` -- No changes are applied at all.
276
276
277
277
Run through without making any changes.
278
-
This can be very usefull, because it outputs what would happend without doing anything.
278
+
This can be very useful because it outputs what would happen without doing anything.
279
279
280
280
281
281
282
282
## 🏁 Next milestones <aname="milestones"></a>
283
283
284
284
We are glad that we have an integration into the CLI again.
285
-
But we are looking forward to the following features:
285
+
However, we are looking forward to the following features:
286
286
287
287
* an interactive command-line prompt that guides you through the available options
288
288
* a configuration file (`angular-cli-ghpages.json`) to avoid all these command-line cmd options
Copy file name to clipboardExpand all lines: docs/README_contributors.md
+12-11Lines changed: 12 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,8 +14,8 @@ npm test
14
14
15
15
## Local development <aname="local-dev"></a>
16
16
17
-
If you want to try the latest package locally without installing it from npm, use the following instructions.
18
-
This may be useful when you want to try the latest nonpublished version of this library or you want to make a contribution.
17
+
If you want to try the latest package locally without installing it from NPM, use the following instructions.
18
+
This may be useful when you want to try the latest non-published version of this library or you want to make a contribution.
19
19
20
20
Follow the instructions for [checking and updating the Angular CLI version](#angular-cli) and then link the package.
21
21
@@ -28,7 +28,7 @@ Follow the instructions for [checking and updating the Angular CLI version](#ang
28
28
npm install -g @angular/cli@next
29
29
```
30
30
31
-
2. Run `ng --version`, make sure you have angular CLI v8.3.0-next.0 or greater.
31
+
2. Run `ng version`, make sure you have installed Angular CLI v8.3.0-next.0 or greater.
32
32
33
33
3. Update your existing project using the command:
34
34
@@ -68,13 +68,14 @@ Use the following instructions to make `angular-cli-ghpages` available locally v
68
68
npm link
69
69
```
70
70
71
+
Read more about the `link` feature in the [official NPM documentation](https://docs.npmjs.com/cli/link).
71
72
72
-
### 3. Adding to an Angular project - ng add <aname="local-dev-add"></a>
73
73
74
-
Once you have completed the previous steps to npm link the local copy of `angular-cli-ghpages`,
75
-
follow these steps to use it in a local angular project.
74
+
### 3. Adding to an Angular project -- ng add <aname="local-dev-add"></a>
76
75
77
-
1. Enter the project's directory
76
+
Once you have completed the previous steps to `npm link` the local copy of `angular-cli-ghpages`, follow these steps to use it in a local Angular project.
77
+
78
+
1. Enter the project directory
78
79
79
80
```sh
80
81
cd your-angular-project
@@ -86,13 +87,13 @@ follow these steps to use it in a local angular project.
86
87
npm link angular-cli-ghpages
87
88
```
88
89
89
-
3. Now execute the schematic.
90
+
3. Now execute the `ng-add`schematic.
90
91
91
92
```sh
92
93
ng add angular-cli-ghpages
93
94
```
94
95
95
-
4.Now you can deploy your angular app to Github pages.
96
+
4.You can now deploy your angular app to GitHub pages.
96
97
97
98
```sh
98
99
ng run your-angular-project:deploy
@@ -118,10 +119,10 @@ npm test
118
119
## Testing the standalone CLI
119
120
120
121
To quickly test the file `engine.ts` directly, the standalone mode is the best option.
121
-
Use VSCode and debug the task `Launch Standalone Program"`.
122
+
Use VSCode and debug the task `Launch Standalone Program`.
0 commit comments