Skip to content

Commit 58be1ca

Browse files
fmalcherJohannesHoppe
authored andcommitted
docs: add note about base-href in quick start guide
fix #103 and #108
1 parent a46dd64 commit 58be1ca

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,14 +90,16 @@ If you already have an existing Angular project on GitHub, skip step 1 and 2.
9090
Your project will be automatically built in production mode.
9191

9292
```sh
93-
ng deploy
93+
ng deploy --base-href=/<repositoryname>/
9494
```
9595

9696
Which is the same as:
9797

9898
```sh
99-
ng deploy your-angular-project
99+
ng deploy your-angular-project --base-href=/<repositoryname>/
100100
```
101+
102+
Please be aware of the `--base-href` option. It is necessary when your project will be deployed to a non-root folder. See more details below.
101103

102104
5. Your project should be available at `https://<username>.github.io/<repositoryname>`.
103105
Learn more about GitHub pages on the [official website](https://pages.github.com/).

0 commit comments

Comments
 (0)