| | |
|---|
| | | |
|---|
| | | ## 🪴 Get Started |
|---|
| | | |
|---|
| | | Quartz requires **at least [Node](https://nodejs.org/) v16** to function correctly. In your terminal of choice, enter the following commands line by line: |
|---|
| | | 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 |
|---|
| | |
|---|
| | | npx quartz create |
|---|
| | | ``` |
|---|
| | | |
|---|
| | | This will guide you through initializing your Quartz with content and previewing it locally. |
|---|
| | | This will guide you through initializing your Quartz with content. Once you've done so, see how to [[build]] and [[hosting|host]] Quartz. |
|---|
| | | |
|---|
| | | 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. |
|---|
| | | > [!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]], [[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]] |
|---|
