From 465804a389f77807f68ca048cf9d7fac1314d8c5 Mon Sep 17 00:00:00 2001 From: Jacky Zhao <j.zhao2k19@gmail.com> Date: Wed, 05 Jul 2023 07:16:06 +0000 Subject: [PATCH] basic docs, remove publish, add quartz create --- content/index.md | 36 ++++++++++++++++++------------------ 1 files changed, 18 insertions(+), 18 deletions(-) diff --git a/content/index.md b/content/index.md index 8faee66..480703c 100644 --- a/content/index.md +++ b/content/index.md @@ -1,27 +1,27 @@ --- -title: Welcome to Quartz -enableToc: false +title: Welcome to Quartz --- -Host your second brain and [digital garden](https://jzhao.xyz/posts/networked-thought) for free. Quartz features +Quartz is a framework for turning Markdown content into a website. -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 +- reduce the friction to go from notes to site +- should work for everyone, from non-technical people to senior developers +- customizability and extensibility -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. +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. -## Get Started -> 📚 Step 1: [Setup your own digital garden using Quartz](notes/setup.md) +> [!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/). -Returning user? Figure out how to [[notes/updating|update]] your existing Quartz garden. +## Installation +Ready to get started? -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). +Prerequisites: +- Node >v16 -### Troubleshooting -- 🚧 [Troubleshooting and FAQ](notes/troubleshooting.md) -- 🐛 [Submit an Issue](https://github.com/jackyzha0/quartz/issues) -- 👀 [Discord Community](https://discord.gg/cRFFHYye7t) - +```shell +git clone https://github.com/jackyzha0/quartz.git +cd quartz +npm i +npx quartz create +``` \ No newline at end of file -- Gitblit v1.10.0