What is Quartz?
Quartz is a set of tools that helps you publish your digital garden and notes as a website for free. It’s a fast, batteries-included static site generator that transforms your Markdown content into a fully functional website with built-in search, graph visualization, and backlinks.“[One] who works with the door open gets all kinds of interruptions, but [they] also occasionally gets clues as to what the world is and what might be important.” — Richard Hamming
Key Features
Quartz comes with powerful features out of the box:Digital Garden Ready
Built specifically for publishing interconnected notes and thoughts with support for wiki-links and backlinks
Markdown Native
Write in Markdown with support for GitHub Flavored Markdown, math equations (KaTeX), and syntax highlighting
Fast & Efficient
Optimized build process with hot-reload during development for instant preview of your changes
Obsidian Compatible
Works seamlessly with Obsidian vaults, supporting multiple link resolution strategies
Built-in Components
Quartz includes several powerful components:- Full-text Search: Fast client-side search powered by FlexSearch
- Graph Visualization: Interactive graph view of note connections using D3.js
- Backlinks: Automatic bidirectional linking between related notes
- Table of Contents: Auto-generated navigation for your pages
- Reading Time: Automatic reading time estimation
- Dark Mode: Built-in theme switching
Technical Stack
Quartz is built with modern web technologies:- Framework: Preact for lightweight, reactive components
- Build Tool: esbuild for blazing-fast builds
- Styling: SCSS with Lightning CSS
- Content Processing: Unified/Remark/Rehype ecosystem
- Runtime: Node.js 22+
Use Cases
Quartz is perfect for:- Personal knowledge bases and digital gardens
- Documentation sites
- Course notes and educational content
- Research notebooks
- Technical blogs with interconnected posts
- Team wikis and shared knowledge repositories
Version
This documentation covers Quartz v4, the latest major version with significant improvements in performance, customization, and developer experience.Ready to get started? Continue to the Installation guide to set up Quartz.
Community & Support
- Documentation: https://quartz.jzhao.xyz/
- GitHub: https://github.com/jackyzha0/quartz
- Discord: Join the Discord Community
- License: MIT