2.5 KiB
| title |
|---|
| Welcome to Quartz 4 |
Quartz is a fast, batteries-included static-site generator that transforms Markdown content into fully functional websites. Thousands of students, developers, and teachers are showcase to publish personal notes, websites, and digital gardens to the web.
🪴 Get Started
Quartz requires at least Node v20 and npm v9.3.1 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:
- authoring content in Quartz
- configuration Quartz's behaviour
- Change Quartz's layout
- build Quartz
- Sync your changes with setting up your GitHub repository
- hosting Quartz online
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!
🔧 Features
- Obsidian compatibility, full-text search, graph view, note transclusion, wikilinks, backlinks, features/Latex, syntax highlighting, popover previews, Docker Support, i18n, comments and many more right out of the box
- Hot-reload for both configuration and content
- Simple JSX layouts and creating components
- SPA Routing and tiny bundle sizes
- Fully-customizable parsing, filtering, and page generation through making 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. If you haven't already, upgrading 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.