Guide · Open source
How to use Quartz: publish Markdown notes as a website
Updated · written with AI from the project's own documentation and checked against our catalogue data
Quartz is an open-source tool that turns a folder of Markdown notes into a website, and it is often used to publish a digital garden, which is a personal collection of linked notes. This guide explains what Quartz is, what you need before you start, how to get the code, and where to find the full documentation. It is written for readers who are comfortable with files and the command line but are not necessarily developers.
Quartzjackyzha0/quartz · ★ 13.5k · MIT Install options & downloads Quick start
- 1Check prerequisites. Install Git and Node.js. The README does not state a Node.js version, so confirm the required version in the documentation.
- 2Clone the repository. Run git clone https://github.com/jackyzha0/quartz in a terminal to download the project.
- 3Read the documentation. Open https://quartz.jzhao.xyz and follow the getting-started guide for build and run steps.
- 4Add your Markdown notes. Prepare the Markdown files you want to publish, such as notes exported from Obsidian.
- 5Build the site. Follow the build steps in the documentation to generate the website from your notes.
- 6Customise if needed. Edit the TypeScript code to change the look or behaviour of the site, if you are comfortable with that.
What Quartz does
Quartz is a static-site generator. It takes Markdown content and produces a website from it. The project describes itself as a fast, batteries-included tool, and its README says it helps you publish your digital garden and notes as a website for free.
Because it is a static-site generator, the finished site is a set of pre-built pages rather than a server running application logic. That makes it a good fit for notes and digital gardens, and a poor fit for sites that need user accounts or server-side processing.
- Input: Markdown notes
- Output: a website built from those notes
- Typical use: a digital garden or personal notes site
- Licence: MIT
What you need before you start
The README provided for this guide does not specify a Node.js version, so check the documentation for the version you need. You will also need Git to copy the project to your computer.
Quartz is written in TypeScript. You do not need to know TypeScript to publish notes, but it helps if you want to customise the site.
- Git
- Node.js (the required version is not stated in the provided README)
- Your notes in Markdown, for example from Obsidian
Get the Quartz code
Quartz is installed by cloning its repository and building it. Run the following command in a terminal to download the project. The rest of the setup steps, including building and running, are described in the official documentation.
git clone https://github.com/jackyzha0/quartzRead the official documentation for setup
The full getting-started guide lives on the project's documentation site at quartz.jzhao.xyz. The README points there for setup instructions, so use it as the source of truth for build and run commands. A Discord community is also linked from the README if you have questions.
If the README you are reading is truncated, as the one used for this guide is, the documentation is the most reliable place to confirm each step.
- Documentation: https://quartz.jzhao.xyz
- Community: the Discord link in the project README
Choose between Quartz and similar tools
Quartz is one of several ways to publish notes. Hugo and Jekyll are general static-site generators, and Obsidian Publish is a hosted option tied to Obsidian. Quartz is aimed at people who keep Markdown notes and want a free, self-hosted site built from them.
Pick Quartz if you are comfortable with a clone-and-build workflow and want control over the site. Pick a hosted option if you want to avoid building anything yourself.
- Quartz: free, built from Markdown, customisable in TypeScript
- Hugo and Jekyll: general static-site generators
- Obsidian Publish: hosted publishing for Obsidian users
What people use it for
- Publishing a personal digital garden of linked notes
- Sharing Obsidian notes as a public website
- Hosting a free personal notes site
- Customising the layout of a static notes website with TypeScript
Frequently asked questions
Is Quartz free to use?
Quartz is released under the MIT licence, and its README describes it as a tool for publishing notes as a website for free. Check the licence file in the repository for the full terms.
What do I need to install Quartz?
The README lists Git and Node.js as prerequisites. The README does not give a Node.js version, so check the documentation before you install.
How do I install Quartz?
The README shows how to clone the repository with git clone https://github.com/jackyzha0/quartz. Build and run steps are in the official documentation at quartz.jzhao.xyz.
Can I use Quartz with Obsidian?
Quartz is aimed at people who keep notes in Markdown, and Obsidian users are a common audience for it. The README does not describe a specific Obsidian integration, so confirm the workflow in the documentation.
Is Quartz a good alternative to Obsidian Publish?
Obsidian Publish is a hosted option, while Quartz is a free, self-hosted tool you build yourself. Choose Quartz if you want control and are comfortable with a clone-and-build setup.
Can non-developers use Quartz?
Quartz suits people comfortable with the command line and Git. If you need a point-and-click website builder, a hosted tool will be easier.
New agent skills, repos and AI tools — every week
The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.
Our verdict
Quartz suits people who keep notes in Markdown, especially Obsidian users, and want a free digital garden site they can customise. It is less suitable for non-technical users who need a point-and-click builder, or for sites that need user accounts or server-side logic.
Install options & downloads