2023-07-23 18:49:26 +00:00
|
|
|
---
|
|
|
|
|
title: "Building your Quartz"
|
|
|
|
|
---
|
2023-08-07 00:09:29 +00:00
|
|
|
|
2023-08-12 05:47:50 +00:00
|
|
|
Once you've [[index#🪴 Get Started|initialized]] Quartz, let's see what it looks like locally:
|
2023-08-07 00:09:29 +00:00
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
npx quartz build --serve
|
|
|
|
|
```
|
|
|
|
|
|
2023-08-12 05:47:50 +00:00
|
|
|
This will start a local web server to run your Quartz on your computer. Open a web browser and visit `http://localhost:8080/` to view it.
|
2023-08-07 00:09:29 +00:00
|
|
|
|
|
|
|
|
> [!hint] Flags and options
|
|
|
|
|
> For full help options, you can run `npx quartz build --help`.
|
2023-08-07 02:54:11 +00:00
|
|
|
>
|
2023-08-07 00:09:29 +00:00
|
|
|
> Most of these have sensible defaults but you can override them if you have a custom setup:
|
2023-08-07 02:54:11 +00:00
|
|
|
>
|
2023-08-07 00:09:29 +00:00
|
|
|
> - `-d` or `--directory`: the content folder. This is normally just `content`
|
|
|
|
|
> - `-v` or `--verbose`: print out extra logging information
|
|
|
|
|
> - `-o` or `--output`: the output folder. This is normally just `public`
|
|
|
|
|
> - `--serve`: run a local hot-reloading server to preview your Quartz
|
2023-08-07 02:54:11 +00:00
|
|
|
> - `--port`: what port to run the local preview server on
|
2023-08-09 05:52:49 +00:00
|
|
|
> - `--concurrency`: how many threads to use to parse notes
|
2024-09-15 23:47:11 +00:00
|
|
|
|
|
|
|
|
> [!warning] Not to be used for production
|
|
|
|
|
> Serve mode is intended for local previews only.
|
|
|
|
|
> For production workloads, see the page on [[hosting]].
|
