Tiny-Lab/Local/storage/thlab-notes/worker/docs/getting-started/index.md

title

title
Getting Started

This guide walks you through setting up Quartz from scratch. If you already ran the index#🪴 Get Started on the home page, you can skip ahead to whichever step you're on.

Prerequisites

You need these tools installed before continuing:

• Node.js v22 or later (run node -v to check)
• npm v10.9.2 or later (bundled with Node — run npm -v to check)
• Git (run git -v to check)

[!warning] Common issues

• Linux: System packages (apt install nodejs) often ship much older versions. Use nvm or the NodeSource repository to get Node.js v22.
• Windows: When installing Git, make sure "Git from the command line and also from 3rd-party software" is selected so that git is available in your terminal. If node -v or git -v shows "command not found", restart your terminal or check your PATH.
• macOS: The Xcode command-line tools include Git (xcode-select --install). For Node.js, nvm or the official installer both work.

Setup Steps

Follow these in order:

1. installation — Get Quartz (via GitHub template or clone), install dependencies, run the setup wizard (npx quartz create), install plugins, and preview your site locally
2. authoring-content — Write and organize your Markdown notes in the content/ folder
3. installation#Setting Up Your GitHub Repository — Create a repository and push your site with npx quartz sync
4. hosting — Host your site for free on GitHub Pages, Cloudflare, Netlify, or Vercel

Upgrading & Migrating

• whats-new — Overview of new features and changes
• upgrading — Keep your Quartz installation up to date
• migrating — Migrate from Quartz 4 or Quartz 3