assembly/docs/getting-started/index.md at ad685b8d4eaecb5bb4db4e4a20ae75f2fdbdfa67

mirror of https://github.com/logos-co/assembly.git synced 2026-08-31 13:11:12 +00:00

Files

T

saberzero1 ee683e0e86 docs: add What's New in Quartz 5 page for release

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.

2026-05-24 18:37:33 +02:00

1.3 KiB

Raw Blame History

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

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)

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
installation#Setting Up Your GitHub Repository — Create a repository and push your site with npx quartz sync
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

1.3 KiB Raw Blame History

Prerequisites

Setup Steps

Upgrading & Migrating

1.3 KiB

Raw Blame History