| | |
|---|
| | | --- |
|---|
| | | 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/) v16** to function correctly. In your terminal of choice, enter the following commands line by line: |
|---|
| | | |
|---|
| | | ## Get Started |
|---|
| | | > ð Step 1: [Setup your own digital garden using Quartz](notes/setup.md) |
|---|
| | | ```shell |
|---|
| | | git clone https://github.com/jackyzha0/quartz.git |
|---|
| | | cd quartz |
|---|
| | | git checkout v4-alpha |
|---|
| | | npm i |
|---|
| | | npx quartz create |
|---|
| | | ``` |
|---|
| | | |
|---|
| | | Returning user? Figure out how to [[notes/updating|update]] your existing Quartz garden. |
|---|
| | | This will guide you through initializing your Quartz with content and previewing it locally. |
|---|
| | | |
|---|
| | | 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). |
|---|
| | | 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. |
|---|
| | | |
|---|
| | | ### Troubleshooting |
|---|
| | | - ð§ [Troubleshooting and FAQ](notes/troubleshooting.md) |
|---|
| | | - ð [Submit an Issue](https://github.com/jackyzha0/quartz/issues) |
|---|
| | | - ð [Discord Community](https://discord.gg/cRFFHYye7t) |
|---|
| | | ## ð§ 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](/features). 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](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). |
|---|
