Skip to content

Commit

Permalink
basic docs, remove publish, add quartz create
Browse files Browse the repository at this point in the history
  • Loading branch information
jackyzha0 committed Jul 5, 2023
1 parent 92ca787 commit 465804a
Show file tree
Hide file tree
Showing 35 changed files with 170 additions and 955 deletions.
31 changes: 0 additions & 31 deletions .github/workflows/publish.yaml

This file was deleted.

1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@
.gitignore
node_modules
public
.obsidian
.quartz-cache
Empty file.
3 changes: 3 additions & 0 deletions content/advanced/making plugins.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Making your own plugins
---
Empty file.
36 changes: 18 additions & 18 deletions content/index.md
Original file line number Diff line number Diff line change
@@ -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).

### Troubleshooting
- 🚧 [Troubleshooting and FAQ](notes/troubleshooting.md)
- 🐛 [Submit an Issue](https://github.com/jackyzha0/quartz/issues)
- 👀 [Discord Community](https://discord.gg/cRFFHYye7t)
Prerequisites:
- Node >v16

```shell
git clone https://github.com/jackyzha0/quartz.git
cd quartz
npm i
npx quartz create
```
42 changes: 0 additions & 42 deletions content/notes/CJK + Latex Support (测试).md

This file was deleted.

63 changes: 0 additions & 63 deletions content/notes/callouts.md

This file was deleted.

Loading

0 comments on commit 465804a

Please sign in to comment.