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.
Quartz requires at least Node v22 and npm v10.9.2 to function correctly. Ensure you have this installed on your machine before continuing.
Then, in your terminal of choice, enter the following commands line by line:
git clone https://github.com/jackyzha0/quartz.git
cd quartz
npm i
npx quartz create
This will guide you through initializing your Quartz with content. Once you’ve done so, see how to:
If you prefer instructions in a video format you can try following Nicole van der Hoeven’s video guide on how to set up Quartz!
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.
Having trouble with Quartz? Try searching for your issue using the search feature. 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.