Overview
Quartz 5 is an extensible Markdown static site generator specifically optimized for rendering Obsidian vaults. It introduces a modular YAML-based configuration format (quartz.config.yaml) and an independent plugin system that replaces the TypeScript configurations of previous versions.
Key Findings
1. Extensible Plugin System
- Modular Architecture: Features like wikilinks, latex parsing, pagefind indexing, and interactive graph views are separate plugins.
- Independent Installation: Custom and community plugins can be dynamically added and managed using
npx quartz plugincommands.
2. Configuration (quartz.config.yaml)
- YAML Standard: Shifted from TypeScript to YAML config files.
- JSON Schema Validation: Standard configuration comes with auto-complete and error checks verified during editing or builds.
3. CLI Commands
npx quartz create: Inits Quartz inside a vault.npx quartz build --serve: Compiles and launches a local server with live-reloading.npx quartz check: Validates files and configs.
4. Upgrade Gotchas
- TypeScript Migration: Upgrading from v4 requires transforming
quartz.config.tsintoquartz.config.yaml. - Node Requirements: Requires Node.js v22+ to run modern AST transformations and emitters.
Related Topics
- CS2DOCS: Session-to-Cheat-Sheet Synthesis
- docskurby: Holistic Scraping & Kurby Compression
- Hugo Documentation Automation
Evolution Notes
Content last updated: 2026-06-11 Next review: 2026-06-18