🪨 Quartz 5 Overview

Quartz 5 is an extensible, YAML-configured static site generator optimized for publishing digital gardens and Obsidian vaults. It utilizes concurrent pipeline emitters and a modular plugin architecture to process Markdown syntax, ASTs, and JSON Canvas natively.

🚀 Quick Start

• Initialize project: Run npx quartz create to link your Obsidian vault and create a new workspace.
• Local development: Run npx quartz build --serve for live, concurrent incremental builds with hot-reloading.
• Compile production files: Run npx quartz build to output optimized HTML/CSS/JS assets to the public/ directory.
• Deploy: Host generated static assets on GitHub Pages, Cloudflare Pages, Netlify, or Vercel.

💻 CLI Commands

Command	Action
npx quartz create	Initialize Quartz project inside an Obsidian vault.
npx quartz build --serve	Compile and launch local server with live-reloading.
npx quartz build	Compile static files for production deployment.
npm run check	Validate quartz.config.yaml formatting and run typechecks.
npx quartz plugin add <github-url>	Install community-authored plugins directly from GitHub.
npx quartz plugin install --from-config	Restore all plugins listed in the project configuration.
npx quartz plugin install --latest	Update all plugins and resolve lockfile sync issues.