Skip to content

Commit abfe2b4

Browse files
committed
docs: Minor corrections
@JohannesHoppe
1 parent c19fc7b commit abfe2b4

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -131,8 +131,8 @@ ng deploy --repo=https://github.com/<username>/<repositoryname>.git --name="Your
131131
* __optional__
132132
* Default: `undefined` (string)
133133
* Example:
134-
* `ng deploy` -- `<base href="/">` remains unchanged in your `index.html`
135-
* `ng deploy --base-href=/the-repositoryname/` -- `<base href="/the-repositoryname/">` is added to your `index.html`
134+
* `ng deploy` – The tag `<base href="/">` remains unchanged in your `index.html`
135+
* `ng deploy --base-href=/the-repositoryname/` – Tha tag `<base href="/the-repositoryname/">` is added to your `index.html`
136136

137137
Specifies the base URL for the application being built.
138138
Same as `ng build --base-href=/XXX/`
@@ -181,8 +181,8 @@ Learn more about [GitHub tokens here](https://help.github.com/articles/creating-
181181
* __optional__
182182
* Default: `production` (string)
183183
* Example:
184-
* `ng deploy` -- Angular project is build in production mode
185-
* `ng deploy --configuration=qs` -- Angular project is using the configuration `qs` (this configuration must exist in the `angular.json` file)
184+
* `ng deploy` Angular project is build in production mode
185+
* `ng deploy --configuration=qs` Angular project is using the configuration `qs` (this configuration must exist in the `angular.json` file)
186186

187187
A named build target, as specified in the `configurations` section of `angular.json`.
188188
Each named target is accompanied by a configuration of option defaults for that target.
@@ -194,7 +194,7 @@ Same as `ng build --configuration=XXX`.
194194
* Default: `Auto-generated commit` (string)
195195
* Example: `ng deploy --message="What could possibly go wrong?"`
196196

197-
The commit message, __must be wrapped in quotes__ if there are any spaces in the text.
197+
The commit message __must be wrapped in quotes__ if there are any spaces in the text.
198198
Some handy additional text is always added,
199199
if the environment variable `TRAVIS` exists (for Travis CI) or
200200
if the environment variable `CIRCLECI` exists (for Circle CI).
@@ -226,40 +226,40 @@ In this case, provide **both** `name` and `email` string values to identify the
226226
* __optional__
227227
* Default: silent `true` (boolean)
228228
* Example:
229-
* `ng deploy` -- Logging is in silent mode by default.
230-
* `ng deploy --no-silent` -- Logging shows extended information.
229+
* `ng deploy` Logging is in silent mode by default.
230+
* `ng deploy --no-silent` Logging shows extended information.
231231

232232
Logging is in silent mode by default.
233233
In silent mode, log messages are suppressed and error messages are sanitized.
234234

235235
The `--no-silent` option enables extended console logging.
236236
Keep this untouched if the repository URL or other information passed to git commands is sensitive!
237237

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).
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).
239239
> By default the silent mode is enabled to avoid sensitive data exposure.
240240
241241

242242
#### --no-dotfiles <a name="no-dotfiles"></a>
243243
* __optional__
244244
* Default: dotfiles `true` (boolean)
245245
* Example:
246-
* `ng deploy` -- Dotfiles are included by default.
247-
* `ng deploy --no-dotfiles` -- Dotfiles are ignored.
246+
* `ng deploy` Dotfiles are included by default.
247+
* `ng deploy --no-dotfiles` Dotfiles are ignored.
248248

249-
The command includes dotfiles by default (e.g `.htaccess` will be committed)
249+
The command includes dotfiles by default (e.g. `.htaccess` will be committed).
250250
With `--no-dotfiles` files starting with `.` are ignored.
251251

252252
**Hint:**
253253
This is super useful if you want to publish a `.nojekyll` file.
254254
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.
255+
Static content is still delivered even without Jekyll.
256256
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.
257257
→ Or just don't use underscores!
258258

259259

260260
#### --cname <a name="cname"></a>
261261
* __optional__
262-
* Default: `undefined` (string) -- No CNAME file is generated
262+
* Default: `undefined` (string) No CNAME file is generated
263263
* Example:
264264
* `ng deploy --cname=example.com`
265265

@@ -271,8 +271,8 @@ A CNAME file will be created enabling you to use a custom domain.
271271
* __optional__
272272
* Default: `false` (boolean)
273273
* Example:
274-
* `ng deploy` -- Normal behavior: Changes are applied.
275-
* `ng deploy --dry-run` -- No changes are applied at all.
274+
* `ng deploy` Normal behavior: Changes are applied.
275+
* `ng deploy --dry-run` No changes are applied at all.
276276

277277
Run through without making any changes.
278278
This can be very useful because it outputs what would happen without doing anything.

0 commit comments

Comments
 (0)