Getting Started

quickstart:

• already completed quickstart: skip to current step

Prerequisites

requirements:

• Node.js v22+: node -v
• npm v10.9.2+: npm -v
• Git: git -v

OS-Specific Notes

os_notes: linux: - avoid default package managers (apt install nodejs): outdated Node.js - use nvm or NodeSource windows: - during Git install, select “Git from the command line and also from 3rd-party software” - restart terminal if commands are unavailable macos: - install Git via Xcode command-line tools: xcode-select --install - install Node.js via nvm or official installer

Setup Steps

steps:

• Installation:
  • clone or template repository
  • run setup wizard: npx quartz create
  • install dependencies/plugins
  • preview locally
• Authoring Content:
  • write Markdown notes in content/
• Push to GitHub:
  • create repository
  • push content: npx quartz sync
• Deploy:
  • host via GitHub Pages, Cloudflare, Netlify, or Vercel

Upgrading & Migrating

resources:

• What’s New in Quartz 5: features, changes
• Upgrading Quartz: update installation
• Migrating to Quartz 5: upgrade from Quartz 3 or 4