This guide walks you through setting up Quartz from scratch. If you already ran the quickstart on the home page, you can skip ahead to whichever step you’re on.
Prerequisites
- Node.js v22 or later (run
node -vto check) - npm v10.9.2 or later (bundled with Node — run
npm -vto check) - Git (run
git -vto check)
Setup Steps
Follow these in order:
- Installation — Clone Quartz, install dependencies, run the setup wizard (
npx quartz create), install plugins, and preview your site locally - Authoring Content — Write and organize your Markdown notes in the
content/folder - Push to GitHub — Create a repository and push your site with
npx quartz sync - Deploy — Host your site for free on GitHub Pages, Cloudflare, Netlify, or Vercel
Upgrading & Migrating
- What’s New in Quartz 5 — Overview of new features and changes
- Upgrading Quartz — Keep your Quartz installation up to date
- Migrating to Quartz 5 — Migrate from Quartz 4 or Quartz 3