Quartz is a fast, batteries-included static-site generator that transforms Markdown content into fully functional websites. Thousands of students, developers, and teachers are already using Quartz to publish personal notes, websites, and digital gardens to the web.
🪴 Get Started
Quartz requires at least Node v22 and npm v10.9.2 to function correctly. Ensure you have these installed on your machine before continuing.
# 1. Clone the Quartz repository
git clone https://github.com/jackyzha0/quartz.git
cd quartz
# 2. Install dependencies
npm i
# 3. Initialize your site (choose a template, set your base URL, import content)
npx quartz create
# 4. Install plugins referenced by your chosen template
npx quartz plugin install --from-config
# 5. Preview your site locally
npx quartz build --serveYour site is now running at http://localhost:8080. From here:
- Write content in the
content/folder - Push to GitHub with
npx quartz sync - Deploy to GitHub Pages, Cloudflare, Netlify, or Vercel
For the full walkthrough, see the Getting Started guide.
Returning User?
Already have a Quartz repository and cloning it on a new machine?
git clone https://github.com/<your-username>/<your-repo>.git
cd <your-repo>
npm ci
npx quartz plugin install
npx quartz build --serveTip
If you hit build errors on a fresh clone, try
npx quartz plugin install --latestto refresh plugins to their latest versions. See troubleshooting for details.
🔧 Features
- Obsidian compatibility, full-text search, graph view, wikilinks, transclusions, Backlinks, Latex, syntax highlighting, popover previews, Docker Support, internationalization, comments and many more right out of the box
- Hot-reload on configuration edits and incremental rebuilds for content edits
- Simple JSX layouts and page components
- Ridiculously fast page loads and tiny bundle sizes
- Fully-customizable parsing, filtering, and page generation through plugins
For a comprehensive list of features, visit the features page. You can read more about the why behind these features on the philosophy page and a technical overview on the architecture page.
🚧 Troubleshooting + Updating
Having trouble with Quartz? Try searching for your issue using the search feature or check the troubleshooting page. If you haven’t already, upgrade to the newest version of Quartz to see if this fixes your issue.
If you’re still having trouble, feel free to submit an issue if you feel you found a bug or ask for help in our Discord Community. You can also browse the community page for third-party plugins and resources.