🪨 Quartz 5 Overview

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

🚀 Quick Start

• 🏗️ Init: npx quartz create to link an Obsidian vault and create a workspace.
• ⚡ Dev: npx quartz build --serve for live, concurrent incremental builds with hot-reloading.
• 📦 Prod: npx quartz build to compile optimized HTML/CSS/JS assets to public/.
• 🌍 Deploy: Host public/ assets on GitHub Pages, Cloudflare Pages, Netlify, or Vercel.

💻 CLI Commands

Command	Action
npx quartz create	Initialize project inside an Obsidian vault.
npx quartz build --serve	Compile and launch local dev server.
npx quartz build	Compile static files for production.
npm run check	Validate quartz.config.yaml and typechecks.
npx quartz plugin add <url>	Install community plugins from GitHub.
npx quartz plugin install --from-config	Restore plugins from configuration.
npx quartz plugin install --latest	Update plugins and sync lockfile.

🔗 Related Docs

• 01-Configuration
• 02-Architecture-Plugins
• 03-Best-Practices-Gotchas