Getting Started with Quartz

Quartz is a fast, batteries-included static site generator that transforms Markdown content into a fully functional website.

Key Features

  • 🚀 Fast - Built on Hugo for blazing fast build times
  • 🔍 Full-text search - Search across all your content instantly
  • 📊 Graph view - Visualize connections between your notes
  • 🌙 Dark mode - Easy on the eyes
  • 📱 Mobile friendly - Responsive design that works everywhere

Basic Commands

# Build and serve locally
npx quartz build --serve
 
# Build for production
npx quartz build
 
# Sync with GitHub
npx quartz sync

File Structure

  • /content - Your markdown files go here
  • /quartz.config.ts - Site configuration
  • /quartz.layout.ts - Layout configuration

Next Steps