Skip to content

docs(serverOptions): moved options from archived doc to the docs section #1287

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
JosefBredereck merged 3 commits into from
Feb 19, 2021
Merged

docs(serverOptions): moved options from archived doc to the docs section #1287

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4665ecd
docs(serverOptions): moved options from archived document to the main…
Feb 5, 2021
53161dd
feat(ignorePattern): added another option
Feb 8, 2021
efd5d07
fix(wait): corrected the default value
Feb 8, 2021
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
16 changes: 15 additions & 1 deletion packages/docs/src/docs/advanced-config-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,21 @@ Used to activate rendering flat patterns on view all pages and generate view all

### serverOptions

Sets live-server options. See the [live-server documentation](https://github.com/pattern-lab/live-server#usage-from-node) for more details.
Sets [live-server options](https://github.com/pattern-lab/live-server#usage-from-node):

| key | example value | description |
|---------------|----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| port | 8181 | Set the server port. Defaults to 8080. |
| host | "0.0.0.0" | Set the address to bind to. Defaults to 0.0.0.0 or process.env.IP. |
| root | "/public" | Set root directory that's being served. Defaults to cwd. |
| open | false | When false, it won't load your browser by default. |
| ignore | 'scss,my/templates' | Live-Reload: Comma-separated string for paths to ignore from watching for changes in the filesystem. Use with caution: This would overwrite the default 'public' path, that's highly recommended to get ignored. |
| ignorePattern | | Live-Reload: Regular expression for ignoring specific file types from being watched for changes in the filesystem. |
| file | "index.html" | When set, serve this file for every 404 (useful for single-page applications). |
| wait | 100 | Waits for all changes, before reloading. Defaults to 0 sec. |
| mount | [['/components', './node_modules']] | Mount a directory to a route. |
| logLevel | 2 | 0 = errors only, 1 = some, 2 = lots |
| middleware | [function(req, res, next) { next(); }] | Takes an array of Connect-compatible middleware that are injected into the server middleware stack |

**default**:

Expand Down