---

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|already using Quartz]] to publish personal notes, wikis, and digital gardens to the web.

🪴 Get Started

Quartz requires at least Node v18.14 to function correctly. In your terminal of choice, enter the following commands line by line:

git clone https://github.com/jackyzha0/quartz.git
cd quartz
git checkout v4-alpha
npm i
npx quartz create

This will guide you through initializing your Quartz with content.

When you're ready, you can edit quartz.config.ts to customize and configure Quartz more. Read the [[configuration]] page for more information on what each field in the configuration does.

Then, when you're ready, see how to [[build]] and [[hosting|host]] Quartz.

🔧 Features

• [[full-text search|Full-text search]], [[graph view]], [[backlinks]], [[Latex]], [[syntax highlighting]], [[popover previews]], and many more right out of the box
• Simple JSX [[creating components|layouts and page components]]
• [[SPA Routing|Ridiculously fast page loads]] and tiny bundle sizes
• Fully-customizable parsing, filtering, and page generation through [[making plugins|plugins]]

For a comprehensive list of features, visit the features page. You can read more the why behind these features on the [[philosophy]] page.

🚧 Troubleshooting

Having trouble with Quartz? Try searching for your issue using the search feature. 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.