| | |
|---|
| | | 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. |
|---|
| | | 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, websites, 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. |
|---|
| | | Quartz requires **at least [Node](https://nodejs.org/) v22** and `npm` v10.9.2 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: |
|---|
| | | |
|---|
| | |
|---|
| | | |
|---|
| | | This will guide you through initializing your Quartz with content. Once you've done so, see how to: |
|---|
| | | |
|---|
| | | 1. [[authoring content|Author content]] in Quartz |
|---|
| | | 1. [[authoring content|Writing 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 |
|---|
| | | 5. Sync your changes with [[setting up your GitHub repository|GitHub]] |
|---|
| | | 6. [[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. |
|---|
| | | If you prefer instructions in a video format you can try following Nicole van der Hoeven's |
|---|
| | | [video guide on how to set up Quartz!](https://www.youtube.com/watch?v=6s6DT1yN4dw&t=227s) |
|---|
| | | |
|---|
| | | ## 🔧 Features |
|---|
| | | |
|---|
| | | - [[Obsidian compatibility]], [[full-text search]], [[graph view]], note transclusion, [[wikilinks]], [[backlinks]], [[Latex]], [[syntax highlighting]], [[popover previews]], and [many more](./features) right out of the box |
|---|
| | | - Hot-reload for both configuration and content |
|---|
| | | - [[Obsidian compatibility]], [[full-text search]], [[graph view]], [[wikilinks|wikilinks, transclusions]], [[backlinks]], [[features/Latex|Latex]], [[syntax highlighting]], [[popover previews]], [[Docker Support]], [[i18n|internationalization]], [[comments]] and [many more](./features/) right out of the box |
|---|
| | | - Hot-reload on configuration edits and incremental rebuilds for content edits |
|---|
| | | - 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. |
|---|
| | | 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 |
|---|
| | | |
|---|
