docs(devserver): add documentation for liveReload option #3051
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Preview is ready Built with commit 4446db1 https://deploy-preview-3051--webpackjsorg-netlify.netlify.com |
wizardofhogwarts
suggested changes
May 18, 2019
|
|
||
| `boolean: true` | ||
|
|
||
| When `devServer.liveReload` is disabled, the dev-server will never reload/refresh the page. |
There was a problem hiding this comment.
never appears to be a bit awkward.
There was a problem hiding this comment.
@wizardofhogwarts i updated the description with more detailed one, can you please check it ? thanks.
EugeneHlushko
requested changes
May 30, 2019
src/content/api/cli.md
Outdated
| @@ -299,6 +300,7 @@ Parameter | Explanation | Usage | |||
| `--define` | Define any free variable, see [shimming](/guides/shimming) | `--define process.env.NODE_ENV="'development'"` | |||
| `--hot` | Enables [Hot Module Replacement](/concepts/hot-module-replacement) | `--hot=true` | |||
| `--labeled-modules` | Enables labeled modules [Uses LabeledModulesPlugin] | | |||
| `--live-reload` | Enables page live reloading | `--live-reload=true` | |||
There was a problem hiding this comment.
Suggested change
| `--live-reload` | Enables page live reloading | `--live-reload=true` | |
| `--live-reload` | Enables live reloading | `--live-reload=true` |
|
|
||
| `boolean: true` | ||
|
|
||
| When `devServer.liveReload` is enabled, the dev-server will reload/refresh the page when file changes if [`devServer.hot`](#devserverhot) option is disabled or [`devServer.watchContentBase`](#devserverwatchcontentbase) is enabled. |
There was a problem hiding this comment.
Suggested change
| When `devServer.liveReload` is enabled, the dev-server will reload/refresh the page when file changes if [`devServer.hot`](#devserverhot) option is disabled or [`devServer.watchContentBase`](#devserverwatchcontentbase) is enabled. | |
| By default, the dev-server will reload/refresh the page when file changes are detected. [`devServer.hot`](#devserverhot) option must be disabled or [`devServer.watchContentBase`](#devserverwatchcontentbase) option must be enabled in order for `liveReload` to take effect. Disable `devServer.liveReload` by setting it to `false`: |
| module.exports = { | ||
| //... | ||
| devServer: { | ||
| liveReload: true |
There was a problem hiding this comment.
Suggested change
| liveReload: true | |
| liveReload: false |
| Usage via the CLI | ||
|
|
||
| ```bash | ||
| webpack-dev-server --live-reload |
There was a problem hiding this comment.
Isn't this default? Why we need to pass it
|
@EugeneHlushko Done 😄. |
EslamHiko
changed the title
EugeneHlushko
approved these changes
Jun 11, 2019
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
add docs for the feature in this pr: webpack/webpack-dev-server#1889