zaine/quartz
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: clarified setup guide

Browse Source
This commit is contained in:
saberzero1
2026-03-31 19:23:08 +02:00
parent 3012aa01ea
commit 8e7100a562
2 changed files with 25 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/cli/build.md
View File

@@ -56,6 +56,19 @@ If you have a very large vault, you can limit the number of concurrent workers t
npx quartz build --concurrency 2
```
## Serve vs Watch
The `--serve` and `--watch` flags control different behaviors:
- **`--serve`** starts a local development server AND automatically watches for changes (implies `--watch`). This is the recommended mode for local development.
- **`--watch`** only watches for file changes and rebuilds automatically, without starting a server. This is useful for CI pipelines or custom server setups where you want automatic rebuilds but handle serving separately.
In most cases, you want `--serve`:
```shell
npx quartz build --serve
```
## Development Server
The `--serve` flag starts a local web server. This server is intended for development and previewing only. It is not designed for production use. For information on how to deploy your site, see [[hosting]].