@@ -38,33 +38,35 @@ To install the command run the following:
3838npm i angular-cli-ghpages --save-dev
3939```
4040
41+ Note: you can skip the permanent installation, too. The command ` npx ` is also able to install ` angular-cli-ghpages ` on the first usage, if you want.
42+
4143## Usage
4244
43- Execute ` npx ngh ` in order to deploy the project with a build from ` dist ` folder.
45+ Execute ` npx angular-cli-ghpages ` in order to deploy the project with a build from ` dist ` folder.
4446__ Note: you have to create the ` dist ` folder in before (e.g. ` ng build --prod ` )__
4547
4648Usage:
4749
4850``` bash
4951ng build --prod --base-href " https://USERNAME.github.io/REPOSITORY_NAME/"
50- npx ngh [OPTIONS]
52+ npx angular-cli-ghpages [OPTIONS]
5153```
5254
5355or
5456
5557``` bash
5658ng build --prod --base-href " /REPOSITORY_NAME/"
57- npx ngh [OPTIONS]
59+ npx angular-cli-ghpages [OPTIONS]
5860```
5961
6062or (` <base href="/"> ` stays untouched)
6163
6264``` bash
6365ng build --prod
64- npx ngh [OPTIONS]
66+ npx angular-cli-ghpages [OPTIONS]
6567```
6668
67- If you want to push to ` gh-pages ` on the same repository with your default credentials, then just enter ` npx ngh ` without any options.
69+ If you want to push to ` gh-pages ` on the same repository with your default credentials, then just enter ` npx angular-cli-ghpages ` without any options.
6870
6971
7072### Usage with Angular CLI 6 or higher
@@ -74,7 +76,7 @@ Please take a look at the `dist` folder to see whether there is a subfolder with
7476If yes, you need to specify the deploy directory manually then when using this tool:
7577
7678``` bash
77- npx ngh --dir=dist/[PROJECTNAME]
79+ npx angular-cli-ghpages --dir=dist/[PROJECTNAME]
7880```
7981
8082I most cases, the ` [PROJECTNAME] ` can be found in the ` angular.json ` file at ` defaultProject ` .
0 commit comments