27 lines
923 B
Markdown
27 lines
923 B
Markdown
---
|
|
title: Welcome to Quartz
|
|
---
|
|
|
|
Quartz is a framework for turning Markdown content into a website.
|
|
|
|
- reduce the friction to go from notes to site
|
|
- should work for everyone, from non-technical people to senior developers
|
|
- customizability and extensibility
|
|
|
|
See some of the [amazing gardens that community members](showcase.md) have published with Quartz or read about [[philosophy|why I made Quartz]] to begin with.
|
|
|
|
> [!info] You are currently looking at the documentation for Quartz 4
|
|
> If you're looking for Quartz 3, you can find the source for that version on the `hugo` branch. Alternatively, you can browse [an archived version of the old documentation on the Wayback Machine](https://web.archive.org/web/20230628023708/https://quartz.jzhao.xyz/).
|
|
|
|
## Installation
|
|
Ready to get started?
|
|
|
|
Prerequisites:
|
|
- Node >v16
|
|
|
|
```shell
|
|
git clone https://github.com/jackyzha0/quartz.git
|
|
cd quartz
|
|
npm i
|
|
npx quartz create
|
|
``` |