Skip to content

Commit da4ac2a

Browse files
committed
docs: update README with fixes and improvements
- Add missing --dir option to TOC - Update copyright year to 2026 - Fix --no-build default type (string → boolean) - Replace deprecated --prod flag with --configuration production - Update branch guidance (main instead of master) - Fix CircleCI capitalization
1 parent 4f8c822 commit da4ac2a

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
- [--no-nojekyll](#no-nojekyll)
3030
- [--cname](#cname)
3131
- [--add](#add)
32+
- [--dir](#dir)
3233
- [--dry-run](#dry-run)
3334
7. [📁 Configuration File](#configuration-file)
3435
8. [🌍 Environments](#environments)
@@ -247,7 +248,7 @@ See the option [--cname](#cname) for more information!
247248

248249
If no `buildTarget` is set, the `production` build of the default project will be chosen.
249250
The `buildTarget` simply points to an existing build configuration for your project, as specified in the `configurations` section of `angular.json`.
250-
Most projects have a default configuration and a production configuration (commonly activated by using the `--prod` flag) but it is possible to specify as many build configurations as needed.
251+
Most projects have a default configuration and a production configuration (commonly activated by using the `--configuration production` option) but it is possible to specify as many build configurations as needed.
251252

252253
This is equivalent to calling the command `ng build --configuration=XXX`.
253254
This command has no effect if the option `--no-build` is active.
@@ -280,7 +281,7 @@ Specifies the Angular architect target to use for prerendering instead of buildT
280281
#### --no-build <a name="no-build"></a>
281282

282283
- **optional**
283-
- Default: `false` (string)
284+
- Default: `false` (boolean)
284285
- Example:
285286
- `ng deploy` – Angular project is build in production mode before the deployment
286287
- `ng deploy --no-build` – Angular project is NOT build
@@ -327,7 +328,7 @@ Some additional text is always added to the message, if the command runs on Trav
327328
The name of the branch you'll be pushing to.
328329
The default uses GitHub's `gh-pages` branch,
329330
but this can be configured to push to any branch on any remote.
330-
You have to change this to `master` if you are pushing to a GitHub organization page (instead of a GitHub user page).
331+
You may need to change this to `main` (or `master` for older repositories) if you are pushing to a GitHub organization page (instead of a GitHub user page).
331332

332333
#### --name & --email <a name="name"></a>
333334

@@ -477,7 +478,7 @@ Now you can just run `ng deploy` without all the options in the command line!
477478
478479
## 🌍 Environments <a name="environments"></a>
479480

480-
We have seen `angular-cli-ghpages` running on various environments, like Travis CI, CircleCi or GitHub Actions.
481+
We have seen `angular-cli-ghpages` running on various environments, like Travis CI, CircleCI or GitHub Actions.
481482
Please share your knowledge by writing an article about how to set up the deployment.
482483

483484
1. [GitHub Actions](https://angular.schule/blog/2020-01-everything-github)
@@ -497,7 +498,7 @@ Code released under the [MIT license](LICENSE).
497498

498499
<img src="https://assets.angular.schule/logo-angular-schule.png" height="60">
499500

500-
### &copy; 2017-2024 https://angular.schule
501+
### &copy; 2017-2026 https://angular.schule
501502

502503
This project is made on top of [tschaub/gh-pages](https://github.com/tschaub/gh-pages).
503504
Thank you very much for this great foundation!

0 commit comments

Comments
 (0)