Jacky Zhao
2023-08-20 425c9789a451e69adbba2d99193e38e8915e8804
content/index.md
@@ -1,27 +1,45 @@
---
title: Welcome to Quartz
enableToc: false
title: Welcome to Quartz 4
---
Host your second brain and [digital garden](https://jzhao.xyz/posts/networked-thought) for free. Quartz features
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.
1. Extremely fast natural-language [[notes/search]]
2. Customizable and hackable design based on [Hugo](https://gohugo.io/)
3. Automatically generated backlinks, link previews, and local graph
4. Built-in [[notes/CJK + Latex Support (æĩ‹čŊ•) | CJK + Latex Support]] and [[notes/callouts | Admonition-style callouts]]
5. Support for both Markdown Links and Wikilinks
## ðŸŠī Get Started
Check out some of the [amazing gardens that community members](notes/showcase.md) have published with Quartz or read about [why I made Quartz](notes/philosophy.md) to begin with.
Quartz requires **at least [Node](https://nodejs.org/) v18.14** to function correctly. Ensure you have this installed on your machine before continuing.
## Get Started
> ðŸ“š Step 1: [Setup your own digital garden using Quartz](notes/setup.md)
Then, in your terminal of choice, enter the following commands line by line:
Returning user? Figure out how to [[notes/updating|update]] your existing Quartz garden.
```shell
git clone https://github.com/jackyzha0/quartz.git
cd quartz
npm i
npx quartz create
```
If you prefer browsing the contents of this site through a list instead of a graph, you see a list of all [setup-related notes](/tags/setup).
This will guide you through initializing your Quartz with content. Once you've done so, see how to:
### Troubleshooting
- ðŸš§ [Troubleshooting and FAQ](notes/troubleshooting.md)
- ðŸ› [Submit an Issue](https://github.com/jackyzha0/quartz/issues)
- ðŸ‘€ [Discord Community](https://discord.gg/cRFFHYye7t)
1. [[authoring content|Author content]] in Quartz
2. [[configuration|Configure]] Quartz's behaviour
3. Change Quartz's [[layout]]
4. [[build|Build and preview]] Quartz
5. [[hosting|Host]] Quartz online
> [!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
- [[Obsidian compatibility]], [[full-text search]], [[graph view]], [[wikilinks]], [[backlinks]], [[Latex]], [[syntax highlighting]], [[popover previews]], and [many more](./features) right out of the box
- Hot-reload for both configuration and content
- Simple JSX layouts and [[creating components|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 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|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](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).