Skip to content

Commit f55a613

Browse files
committed
📝 Add documentation for serve-command
1 parent 7aa8f2c commit f55a613

File tree

2 files changed

+20
-5
lines changed

2 files changed

+20
-5
lines changed

website/docs/commands/serve.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: "Serve Command"
3+
slug: serve
4+
sidebar_label: Serve
5+
---
6+
7+
```bash
8+
chayns-toolkit serve
9+
10+
chayns-toolkit serve -p <number>
11+
```
12+
13+
Serves static files similar to [serve](https://www.npmjs.com/package/serve), but is designed to
14+
simplify serving files from build output as easy as possible.
15+
16+
This will serve all files configured via `output.path` (Default: `build`) and use the port- and
17+
ssl-configuration from the `development`-section. Optionally the port from the config can be
18+
overriden like in the 2nd example above.

website/sidebars.js

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,15 @@ module.exports = {
2222
"commands/dev",
2323
"commands/build",
2424
"commands/lint",
25+
"commands/serve",
2526
"commands/test",
2627
],
2728
},
2829
{
2930
type: "category",
3031
label: "Configuration",
3132
collapsed: false,
32-
items: [
33-
"configuration/development",
34-
"configuration/output",
35-
"configuration/webpack",
36-
],
33+
items: ["configuration/development", "configuration/output", "configuration/webpack"],
3734
},
3835
"contributing",
3936
],

0 commit comments

Comments
 (0)