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.
Getting Started
Quartz requires at least Node v22 and npm v10.9.2 to function correctly. Ensure you have this installed on your machine before continuing.
New to Quartz?
- Set up your repository — Fork and clone the Quartz template
- Initialize — Run
npx quartz createto choose a template and configure your site - Build — Preview your site locally with
npx quartz build --serve - Deploy — Host your site for free on GitHub Pages, Cloudflare, or Netlify
Returning User?
If you’ve already set up Quartz and are cloning your repository on a new machine:
npx quartz plugin install
npx quartz build --serve🔧 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.