quartz-research-note/content/index.md

---
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](https://jzhao.xyz/posts/networked-thought/) to the web.

## 🪴 Get Started

Quartz requires **at least [Node](https://nodejs.org/) v18.14** 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:

```shell
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. Once you've done so, see how to [[build]] and [[hosting|host]] Quartz.

> [!info]
> Coming from Quartz 3? See the [[migrating from Quartz 3|migration guide]] for the differences between Quartz 3 and Quartz 4 and how to migrate.

## 🔧 Features

- [[full-text search|Full-text search]], [[graph view]], [[wikilinks]], [[backlinks]], [[Latex]], [[syntax highlighting]], [[popover previews]], and many more right out of the box
- Hot-reload for both configuration and content
- 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](/features). You can read more the _why_ behind these features on the [[philosophy]] page and a technical overview on the [[architecture]] 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](https://github.com/jackyzha0/quartz/issues) if you feel you found a bug or ask for help in our [Discord Community](https://discord.gg/cRFFHYye7t).
docs updates, add search to main page, fix redir bug 2021-10-25 06:31:09 +00:00			`---`
docs + various polish 2023-07-10 02:32:24 +00:00			`title: Welcome to Quartz 4`
docs updates, add search to main page, fix redir bug 2021-10-25 06:31:09 +00:00			`---`
fix: cjk support + demo page 2022-04-03 00:38:39 +00:00
docs + various polish 2023-07-10 02:32:24 +00:00			`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](https://jzhao.xyz/posts/networked-thought/) to the web.`
feat: basic latex support 2022-04-03 00:00:14 +00:00
docs + various polish 2023-07-10 02:32:24 +00:00			`## 🪴 Get Started`
run prettier 2023-07-23 00:27:41 +00:00
improve hot reload robustness 2023-08-05 22:34:10 +00:00			`Quartz requires at least [Node](https://nodejs.org/) v18.14 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:`
fix: give precedence to date created over last modified if defined (#101) 2022-07-15 21:26:31 +00:00
basic docs, remove publish, add quartz create 2023-07-05 07:16:06 +00:00			```shell
			`git clone https://github.com/jackyzha0/quartz.git`
			`cd quartz`
docs + various polish 2023-07-10 02:32:24 +00:00			`git checkout v4-alpha`
basic docs, remove publish, add quartz create 2023-07-05 07:16:06 +00:00			`npm i`
			`npx quartz create`
docs + various polish 2023-07-10 02:32:24 +00:00			```

mobile fixes, fix bug when linking to anchor on home, docs 2023-08-07 00:09:29 +00:00			`This will guide you through initializing your Quartz with content. Once you've done so, see how to [[build]] and [[hosting\|host]] Quartz.`
improve error handling while serving 2023-07-23 18:49:26 +00:00
improve hot reload robustness 2023-08-05 22:34:10 +00:00			`> [!info]`
			`> Coming from Quartz 3? See the [[migrating from Quartz 3\|migration guide]] for the differences between Quartz 3 and Quartz 4 and how to migrate.`

docs + various polish 2023-07-10 02:32:24 +00:00			`## 🔧 Features`

architecture, fix vendor prefixing 2023-08-08 00:34:38 +00:00			`- [[full-text search\|Full-text search]], [[graph view]], [[wikilinks]], [[backlinks]], [[Latex]], [[syntax highlighting]], [[popover previews]], and many more right out of the box`
mobile fixes, fix bug when linking to anchor on home, docs 2023-08-07 00:09:29 +00:00			`- Hot-reload for both configuration and content`
docs + various polish 2023-07-10 02:32:24 +00:00			`- 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]]`

architecture, fix vendor prefixing 2023-08-08 00:34:38 +00:00			`For a comprehensive list of features, visit the [features page](/features). You can read more the _why_ behind these features on the [[philosophy]] page and a technical overview on the [[architecture]] page.`
docs + various polish 2023-07-10 02:32:24 +00:00
			`### 🚧 Troubleshooting`
run prettier 2023-07-23 00:27:41 +00:00
docs + various polish 2023-07-10 02:32:24 +00:00			`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](https://github.com/jackyzha0/quartz/issues) if you feel you found a bug or ask for help in our [Discord Community](https://discord.gg/cRFFHYye7t).`