forked from jackyzha0/quartz
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
proper backlink and graph display in footer
- Loading branch information
Showing
14 changed files
with
96 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,21 @@ | ||
# 💎 Quartz | ||
Simple second brain and digital garden. 🌱 | ||
# 🌱 Quartz | ||
Simple second brain and digital garden. | ||
|
||
## Why Quartz? | ||
Hosting a public digital garden isn't easy. There are an overwhelming number of tutorials, resources, and guides for tools like [Notion](https://www.notion.so/), [Roam](https://roamresearch.com/), and [Obsidian](https://obsidian.md/), yet none of them have super easy to use *free* tools to publish that garden to the world. | ||
|
||
I've personally found that | ||
1. It's nice to access notes from anywhere | ||
2. Having a public digital garden invites open conversations | ||
3. It makes keeping personal notes and knowledge *playful and fun* | ||
|
||
> “He who works with the door open gets all kinds of interruptions, but he also occasionally gets clues as to what the world is and what might be important.” — Richard Hamming | ||
**The goal of Quartz is to make hosting your own public digital garden free and simple.** | ||
|
||
## Get Started | ||
[directory](moc/directory.md) | ||
The entire Quartz documentation is fully hosted using Quartz! You can navigate it using the interactive Graph view below. | ||
|
||
If you'd prefer more traditional navigation, you can also find all relevant pages through the main directory. | ||
|
||
👉 [Directory](moc/directory.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,16 @@ | ||
--- | ||
title: "Directory" | ||
title: "Quartz Documentation" | ||
--- | ||
|
||
[setup](notes/setup.md) | ||
Welcome to Quartz! Whether you're setting up a website and project for the first time or a seasoned digital gardener, I hope that you'll find something useful about this project. | ||
|
||
Let's get to business and get you started! | ||
|
||
## Setup | ||
📚 [setup](notes/setup.md) | ||
|
||
## Configuration | ||
[config](notes/config.md) | ||
|
||
## Troubleshooting | ||
[troubleshooting](notes/troubleshooting.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
--- | ||
title: "config" | ||
title: "Configuration" | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
title: "Deploying to GitHub Pages" | ||
--- | ||
|
||
Change `baseURL` in `/config.toml` | ||
|
||
```toml | ||
baseURL = "https://quartz.jzhao.xyz/" | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
--- | ||
title: "Obsidian Vault Integration" | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,16 @@ | ||
<ol class="backlinks"> | ||
<h3>Backlinks</h3> | ||
<ul class="backlinks"> | ||
{{$curPage := strings.TrimRight "/" .Page.RelPermalink }} | ||
{{$inbound := index $.Site.Data.linkIndex.index.backlinks $curPage}} | ||
{{if $inbound}} | ||
{{- range $inbound -}} | ||
<li> | ||
<a href="{{index . "source"}}">{{index . "source"}}</a> | ||
</li> | ||
{{- end -}} | ||
</ol> | ||
{{else}} | ||
<li> | ||
No backlinks found | ||
</li> | ||
{{end}} | ||
</ul> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters