Welcome to Quartz 5

overview:

• Quartz: static-site generator converting Markdown to websites.
• examples: showcase, digital gardens

🪴 Get Started

prerequisites:

• Node $\ge$ v22
• npm $\ge$ v10.9.2
• details: prerequisites
• local_deployment: wiki.loca.zone

GitHub users

Create a repository from the GitHub template (Option A), then clone it.

Fresh Setup

commands:

git clone https://github.com/jackyzha0/quartz.git
cd quartz
npm i
npx quartz create
npx quartz plugin install --from-config
npx quartz build --serve

result:

• local_url: http://localhost:8080

next:

• write: Write content in content/
• sync: Sync to GitHub with npx quartz sync
• deploy: Deploy to GitHub Pages, Cloudflare, Netlify, or Vercel
• guide: Getting Started

Returning Users (Cloning Existing Repo)

commands:

git clone https://github.com/<your-username>/<your-repo>.git
cd <your-repo>
npm ci
npx quartz plugin install
npx quartz build --serve

Tip

If builds fail on a fresh clone, run npx quartz plugin install --latest. See troubleshooting > Plugins fail to build on a fresh clone.

🔧 Features

features:

• out_of_the_box:
  • Obsidian compatibility
  • full-text search
  • graph view
  • transclusions
  • Backlinks
  • Latex
  • syntax highlighting
  • popover previews
  • Docker Support
  • internationalization
  • comments
  • index: features
• performance_dev:
  • hot-reload
  • incremental rebuilds
  • fast page loads
  • small bundles
• customization:
  • JSX layouts
  • page components
  • plugin-based parsing/filtering/generation: plugins
• concepts:
  • philosophy
  • architecture

🚧 Troubleshooting + Updating

help:

• self_serve:
  • search existing issues
  • check troubleshooting
  • upgrade Quartz
• support:
  • Submit an issue
  • join Discord
  • browse community