Skip to content

Commit 4a4e88c

Browse files
Update README.md
1 parent 7d7c0b5 commit 4a4e88c

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,10 +133,17 @@ angular-cli-ghpages --repo=https://[email protected]/organisation/your-repo.gi
133133
> You have to treat the GH_TOKEN as secure as a password!
134134
135135

136-
## Known issues
136+
## About the 404 page (specific to github pages only)
137137

138138
The old `github-pages:deploy` command created a `404.html` in the `dist` folder.
139-
This was required to fully support the router [`PathLocationStrategy`](https://angular.io/docs/ts/latest/api/common/index/PathLocationStrategy-class.html). Right now you have to copy `index.html` to `404.html` on your own. Please submit an [issue](https://github.com/angular-buch/angular-cli-ghpages/issues) if you want this feature back.
139+
This was required to fully support the router [`PathLocationStrategy`](https://angular.io/docs/ts/latest/api/common/index/PathLocationStrategy-class.html). Right now you have to copy `index.html` to `404.html` on your own. Please submit an [issue](https://github.com/angular-buch/angular-cli-ghpages/issues) if you really want this feature back.
140+
141+
Example:
142+
```sh
143+
ng build
144+
cp dist/index.html dist/404.html
145+
angular-cli-ghpages [OPTIONS]
146+
```
140147

141148

142149
## License

0 commit comments

Comments
 (0)