Skip to content

Commit 5755602

Browse files
mfranzkeMaximilian
andauthored
docs(serverOptions): moved options from archived doc to the docs section (#1287)
* docs(serverOptions): moved options from archived document to the main docs section to include those options more prominently * feat(ignorePattern): added another option * fix(wait): corrected the default value according to the implementation Co-authored-by: Maximilian <mfr@nzke.net>
1 parent 7bc8dfc commit 5755602

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

packages/docs/src/docs/advanced-config-options.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,21 @@ Used to activate rendering flat patterns on view all pages and generate view all
220220

221221
### serverOptions
222222

223-
Sets live-server options. See the [live-server documentation](https://github.com/pattern-lab/live-server#usage-from-node) for more details.
223+
Sets [live-server options](https://github.com/pattern-lab/live-server#usage-from-node):
224+
225+
| key | example value | description |
226+
|---------------|----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
227+
| port | 8181 | Set the server port. Defaults to 8080. |
228+
| host | "0.0.0.0" | Set the address to bind to. Defaults to 0.0.0.0 or process.env.IP. |
229+
| root | "/public" | Set root directory that's being served. Defaults to cwd. |
230+
| open | false | When false, it won't load your browser by default. |
231+
| 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. |
232+
| ignorePattern | | Live-Reload: Regular expression for ignoring specific file types from being watched for changes in the filesystem. |
233+
| file | "index.html" | When set, serve this file for every 404 (useful for single-page applications). |
234+
| wait | 100 | Waits for all changes, before reloading. Defaults to 0 sec. |
235+
| mount | [['/components', './node_modules']] | Mount a directory to a route. |
236+
| logLevel | 2 | 0 = errors only, 1 = some, 2 = lots |
237+
| middleware | [function(req, res, next) { next(); }] | Takes an array of Connect-compatible middleware that are injected into the server middleware stack |
224238

225239
**default**:
226240

0 commit comments

Comments
 (0)