| | |
|---|
| | | |
|---|
| | | ## 🪴 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. 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. |
|---|
| | | |
|---|
| | | 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 |
|---|
