roadmap/docs/build.md

924 B

title draft
Building your Quartz true

Once you've docs/index#🪴 Get Started Quartz, let's see what it looks like locally:

npx quartz build --serve

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.

[!hint] Flags and options For full help options, you can run npx quartz build --help.

Most of these have sensible defaults but you can override them if you have a custom setup:

  • -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
  • --port: what port to run the local preview server on
  • --concurrency: how many threads to use to parse notes