ee683e0e86
Covers the plugin ecosystem, YAML configuration, Obsidian compatibility, page type system, layout system, performance, CLI, i18n, new plugins, and plugin development changes. Also updates home page clone command for v5 as default branch.
27 lines
1.3 KiB
Markdown
27 lines
1.3 KiB
Markdown
---
|
|
title: Getting Started
|
|
---
|
|
|
|
This guide walks you through setting up Quartz from scratch. If you already ran the [[index#🪴 Get Started|quickstart]] on the home page, you can skip ahead to whichever step you're on.
|
|
|
|
## Prerequisites
|
|
|
|
- **[Node.js](https://nodejs.org/) v22 or later** (run `node -v` to check)
|
|
- **npm v10.9.2 or later** (bundled with Node — run `npm -v` to check)
|
|
- **[Git](https://git-scm.com/)** (run `git -v` to check)
|
|
|
|
## Setup Steps
|
|
|
|
Follow these in order:
|
|
|
|
1. **[[installation|Installation]]** — Clone Quartz, install dependencies, run the setup wizard (`npx quartz create`), install plugins, and preview your site locally
|
|
2. **[[authoring-content|Authoring Content]]** — Write and organize your Markdown notes in the `content/` folder
|
|
3. **[[installation#Setting Up Your GitHub Repository|Push to GitHub]]** — Create a repository and push your site with `npx quartz sync`
|
|
4. **[[hosting|Deploy]]** — Host your site for free on GitHub Pages, Cloudflare, Netlify, or Vercel
|
|
|
|
## Upgrading & Migrating
|
|
|
|
- **[[whats-new|What's New in Quartz 5]]** — Overview of new features and changes
|
|
- **[[upgrading|Upgrading Quartz]]** — Keep your Quartz installation up to date
|
|
- **[[migrating|Migrating to Quartz 5]]** — Migrate from Quartz 4 or Quartz 3
|