Skip to content

docs(dev-server): Add documentation for serveIndex option #2953

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 19, 2019
Merged

docs(dev-server): Add documentation for serveIndex option #2953

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2081388
docs(config): add documentation for `serveIndex` option
EslamHiko Apr 19, 2019
2ea363b
fix small lint error
EslamHiko Apr 19, 2019
cf7c6bd
add default value & rephrasing the description
EslamHiko Apr 19, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions src/content/configuration/dev-server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ contributors:
- Yiidiir
- Loonride
- dmohns
- EslamHiko
---

[webpack-dev-server](https://github.com/webpack/webpack-dev-server) can be used to quickly develop an application. See the [development guide](/guides/development/) to get started.
Expand Down Expand Up @@ -1108,6 +1109,22 @@ Usage via the CLI
webpack-dev-server --quiet
```

## `devServer.serveIndex`

`boolean: true`

Tells dev-server to use [`serveIndex`](https://github.com/expressjs/serve-index) middleware when enabled.

[`serveIndex`](https://github.com/expressjs/serve-index) middleware generates directory listings on viewing directories that don't have an index.html file.

```javascript
module.exports = {
//...
devServer: {
serveIndex: true
}
};
```

## `devServer.setup`

Expand Down