quartz README

The project's README from github.com/jackyzha0/quartz. As one markdown file: README.md.

Quartz v5

“[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

Quartz is a set of tools that helps you publish your digital garden and notes as a website for free.

🔗 Read the documentation and get started: https://quartz.jzhao.xyz/

Join the Discord Community

Sponsors

quartz (jackyzha0/quartz)

Searching Database…

13.4K ·GitHub
What is this?Quartz is a static-site generator that turns Markdown notes into a fully functional website, designed especially for publishing digital gardens and interconnected notes.
Is this a standalone app or a tool I run on my own notes?It is a CLI-driven static-site generator: you run its build command over a folder of Markdown files (often an Obsidian vault) and it outputs a deployable website.
How do I get a site running with Quartz?You bootstrap it via the quartz CLI (./quartz/bootstrap-cli.mjs) and then build/serve locally with a command like 'npx quartz build --serve', pointing it at your Markdown content folder.
What do I need installed before trying Quartz?You need Node.js 22+ and npm 10.9.2+; there's no Python, Go, or Rust requirement.
Does it work with any Markdown notes or only Obsidian vaults?It's built around Obsidian-flavored Markdown (the repo topics explicitly mention obsidian and obsidian-md), so it works best with notes written in that style, though plain Markdown is also supported.
Can I host the generated site anywhere, or does Quartz require a specific host?README doesn't detail hosting, but since it outputs a static site, it can be deployed to any static host (e.g. GitHub Pages, Netlify, Cloudflare Pages).
Does Quartz support a plugin system?Yes, it ships with an installable plugin ecosystem, as shown by community plugins like backlinks, breadcrumbs, citations, and a canvas page renderer listed in its dependencies.
What does 'networked thought' mean for this tool?It refers to Quartz's focus on preserving links between notes (like backlinks and article connections) so your published site reflects the interconnected structure of your knowledge base, not just isolated pages.
Is there a Docker option for running Quartz?Yes, the repo includes Docker support and a dedicated docker-build-push CI workflow for building and publishing a Docker image.
Creator
jackyzha0
Size
39.1 MB
Stars
13.4K
Age
5y
Commits · 90 Days