diff --git a/404.html b/404.html index 6372823e6..14d3b28d9 100644 --- a/404.html +++ b/404.html @@ -1,2 +1,2 @@ -Quartz Example Page
-

404.

Hey! You look a little lost.

\ No newline at end of file +404 Page not found
+

404.

Hey! You look a little lost.

\ No newline at end of file diff --git a/index.html b/index.html index b68b3bba7..9058965dd 100644 --- a/index.html +++ b/index.html @@ -1,43 +1,9 @@ -Quartz Example Page

πŸ’Ž Quartz

Simple second brain and digital garden. 🌱

Why Quartz?

Get Started

directory


\ No newline at end of file +Quartz Example Page
+

🌱 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 +, +Roam +, and +Obsidian +, 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

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


Interactive Graph

\ No newline at end of file diff --git a/index.xml b/index.xml index f4624d034..61d94eea9 100644 --- a/index.xml +++ b/index.xml @@ -1 +1,11 @@ -<link>https://quartz.jzhao.xyz/</link><description>Recent content on</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><atom:link href="https://quartz.jzhao.xyz/index.xml" rel="self" type="application/rss+xml"/><item><title>confighttps://quartz.jzhao.xyz/notes/config/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/config/Directoryhttps://quartz.jzhao.xyz/moc/directory/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/moc/directory/setup config troubleshootingSetuphttps://quartz.jzhao.xyz/notes/setup/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/setup/Having problems? troubleshootingtroubleshootinghttps://quartz.jzhao.xyz/notes/troubleshooting/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/troubleshooting/ \ No newline at end of file +<link>https://quartz.jzhao.xyz/</link><description>Recent content on</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><atom:link href="https://quartz.jzhao.xyz/index.xml" rel="self" type="application/rss+xml"/><item><title>Configurationhttps://quartz.jzhao.xyz/notes/config/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/config/Styling Layouts Home Page PartialsDeploying to GitHub Pageshttps://quartz.jzhao.xyz/notes/hosting/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/hosting/GitHub Pages Custom subdomain Change baseURL in /config.toml +1 baseURL = &#34;https://quartz.jzhao.xyz/&#34; Having problems? Checkout our FAQ and Troubleshooting guide .Editing Content in Quartzhttps://quartz.jzhao.xyz/notes/editing/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/editing/Editing Quartz runs on top of Hugo so all notes are written in Markdown . +All content in your garden can found in the /content folder. To make edits, you can open any of the files and make changes directly and save it. You can organize content into any folder you&rsquo;d like. +To create a link, just create a normal link using Markdown pointing to the document in question. Please note that all links should be relative to the root /content path.Obsidian Vault Integrationhttps://quartz.jzhao.xyz/notes/obsidian/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/obsidian/Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have. +New Vault If you don&rsquo;t have an existing Vault, download +Linking an existing VaultQuartz Documentationhttps://quartz.jzhao.xyz/moc/directory/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/moc/directory/Setup Welcome to Quartz! Whether you&rsquo;re setting up a website and project for the first time or a seasoned digital gardener, I hope that you&rsquo;ll find something useful about this project. +Let&rsquo;s get to business and get you started! +πŸ“š Setup your own digital garden using Quartz πŸ”— Linking with an Obsidian Vault 🎨 Customizing and Styling Quartz 🌍 Hosting Quartz online! Troubleshooting 🚧 Troubleshooting and FAQ πŸ› Submit an IssueSetuphttps://quartz.jzhao.xyz/notes/setup/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/setup/Making your own Quartz Setting up Quartz requires a basic understanding of git. If you are unfamiliar, this resource is a great place to start! +Forking A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project. +Navigate to the GitHub repository for the Quartz project: +πŸ“ Quartz Repository Then, Fork the repository into your own GitHub account.Troubleshooting and FAQhttps://quartz.jzhao.xyz/notes/troubleshooting/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/troubleshooting/ \ No newline at end of file diff --git a/moc/directory/index.html b/moc/directory/index.html index bd7aa10a7..008e08bc9 100644 --- a/moc/directory/index.html +++ b/moc/directory/index.html @@ -1,55 +1,9 @@ -Quartz Example Page
-

Directory

setup -config -troubleshooting


\ No newline at end of file +Quartz Documentation
+

Quartz Documentation

Setup

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!

Troubleshooting


Interactive Graph

\ No newline at end of file diff --git a/moc/index.xml b/moc/index.xml index 2e61c1e95..9fb0bddab 100644 --- a/moc/index.xml +++ b/moc/index.xml @@ -1 +1,3 @@ -Mocs onhttps://quartz.jzhao.xyz/moc/Recent content in Mocs onHugo -- gohugo.ioen-usDirectoryhttps://quartz.jzhao.xyz/moc/directory/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/moc/directory/setup config troubleshooting \ No newline at end of file +Mocs onhttps://quartz.jzhao.xyz/moc/Recent content in Mocs onHugo -- gohugo.ioen-usQuartz Documentationhttps://quartz.jzhao.xyz/moc/directory/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/moc/directory/Setup Welcome to Quartz! Whether you&rsquo;re setting up a website and project for the first time or a seasoned digital gardener, I hope that you&rsquo;ll find something useful about this project. +Let&rsquo;s get to business and get you started! +πŸ“š Setup your own digital garden using Quartz πŸ”— Linking with an Obsidian Vault 🎨 Customizing and Styling Quartz 🌍 Hosting Quartz online! Troubleshooting 🚧 Troubleshooting and FAQ πŸ› Submit an Issue \ No newline at end of file diff --git a/notes/config/index.html b/notes/config/index.html index 1f4aa18f9..e6742507d 100644 --- a/notes/config/index.html +++ b/notes/config/index.html @@ -1,53 +1,3 @@ -Quartz Example Page
-

config


\ No newline at end of file +Configuration
+

Configuration

Styling

Layouts

Home Page

Partials


Interactive Graph

\ No newline at end of file diff --git a/notes/editing/index.html b/notes/editing/index.html new file mode 100644 index 000000000..42119840f --- /dev/null +++ b/notes/editing/index.html @@ -0,0 +1,55 @@ +Editing Content in Quartz
+

Editing Content in Quartz

Editing

Quartz runs on top of +Hugo +so all notes are written in +Markdown +.

All content in your garden can found in the /content folder. To make edits, you can open any of the files and make changes directly and save it. You can organize content into any folder you’d like.

To create a link, just create a normal link using Markdown pointing to the document in question. Please note that all links should be relative to the root /content path.

1
+2
+
For example, I want to link this current document to `config.md`.
+[A link to the config page](config.md)
+

Obsidian

I strongly recommend using +Obsidian +as a way to edit and grow your digital garden. It comes with a really nice editor and graphical interface to preview all of my local files.

πŸ”— +How to link your Obsidian Vault

Of course, all the files are in Markdown so you could just use your favourite text editor of choice, I’m not going to stop you!

Previewing Changes

This step is purely optional and mostly for those who want to see the published version of their digital garden locally before opening it up to the internet. For those who like to live life more on the edge, viewing the garden through Obsidian gets you pretty close to the real thing.

Installing Hugo

Hugo is the static site generator that powers Quartz. If you’d like to preview your site locally, +install Hugo +.

1
+2
+3
+4
+5
+6
+7
+
# Navigate to your local Quartz folder
+$ cd <location-of-your-local-quartz>
+
+# Start local server
+$ hugo server
+
+# View your site in a browser at http://localhost:1313/
+

Install hugo-obsidian

This step is doubly optional and only applies to those who want to see their Interactive Graph and backlinks locally while previewing changes on the site.

Ensure you have Go (>= 1.16) installed.

 1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+
# Clone the Repository
+$ git clone https://github.com/jackyzha0/hugo-obsidian.git
+
+# Install and link `hugo-obsidian` locally
+$ go install .
+
+# Navigate to your local Quartz folder
+$ cd <location-of-your-local-quartz>
+
+# Scrape all links in your Quartz folder and generate info for Quartz
+$ hugo-obsidian -input=content -output=data
+

Afterwards, start the Hugo server as shown above and your local backlinks and interactive graph should be populated!

Publishing Changes

Now that you know the basics of managing your digital garden using Quartz, you can publish it to the internet!

🌍 +Hosting Quartz online!

Having problems? Checkout our +FAQ and Troubleshooting guide +.


Interactive Graph

\ No newline at end of file diff --git a/notes/hosting/index.html b/notes/hosting/index.html new file mode 100644 index 000000000..532818813 --- /dev/null +++ b/notes/hosting/index.html @@ -0,0 +1,7 @@ +Deploying to GitHub Pages
+

Deploying to GitHub Pages

GitHub Pages

Custom subdomain

Change baseURL in /config.toml

1
+
baseURL = "https://quartz.jzhao.xyz/"
+

Having problems? Checkout our +FAQ and Troubleshooting guide +.


Interactive Graph

\ No newline at end of file diff --git a/notes/index.xml b/notes/index.xml index 23207fbda..c2ffbd3af 100644 --- a/notes/index.xml +++ b/notes/index.xml @@ -1 +1,9 @@ -Notes onhttps://quartz.jzhao.xyz/notes/Recent content in Notes onHugo -- gohugo.ioen-usconfighttps://quartz.jzhao.xyz/notes/config/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/config/Setuphttps://quartz.jzhao.xyz/notes/setup/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/setup/Having problems? troubleshootingtroubleshootinghttps://quartz.jzhao.xyz/notes/troubleshooting/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/troubleshooting/ \ No newline at end of file +Notes onhttps://quartz.jzhao.xyz/notes/Recent content in Notes onHugo -- gohugo.ioen-usConfigurationhttps://quartz.jzhao.xyz/notes/config/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/config/Styling Layouts Home Page PartialsDeploying to GitHub Pageshttps://quartz.jzhao.xyz/notes/hosting/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/hosting/GitHub Pages Custom subdomain Change baseURL in /config.toml +1 baseURL = &#34;https://quartz.jzhao.xyz/&#34; Having problems? Checkout our FAQ and Troubleshooting guide .Editing Content in Quartzhttps://quartz.jzhao.xyz/notes/editing/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/editing/Editing Quartz runs on top of Hugo so all notes are written in Markdown . +All content in your garden can found in the /content folder. To make edits, you can open any of the files and make changes directly and save it. You can organize content into any folder you&rsquo;d like. +To create a link, just create a normal link using Markdown pointing to the document in question. Please note that all links should be relative to the root /content path.Obsidian Vault Integrationhttps://quartz.jzhao.xyz/notes/obsidian/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/obsidian/Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have. +New Vault If you don&rsquo;t have an existing Vault, download +Linking an existing VaultSetuphttps://quartz.jzhao.xyz/notes/setup/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/setup/Making your own Quartz Setting up Quartz requires a basic understanding of git. If you are unfamiliar, this resource is a great place to start! +Forking A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project. +Navigate to the GitHub repository for the Quartz project: +πŸ“ Quartz Repository Then, Fork the repository into your own GitHub account.Troubleshooting and FAQhttps://quartz.jzhao.xyz/notes/troubleshooting/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/troubleshooting/ \ No newline at end of file diff --git a/notes/obsidian/index.html b/notes/obsidian/index.html new file mode 100644 index 000000000..efa2b7b11 --- /dev/null +++ b/notes/obsidian/index.html @@ -0,0 +1,3 @@ +Obsidian Vault Integration
+

Obsidian Vault Integration

Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have.

New Vault

If you don’t have an existing Vault, download

Linking an existing Vault


Interactive Graph

\ No newline at end of file diff --git a/notes/setup/index.html b/notes/setup/index.html index 1c4649d4a..85f8525b8 100644 --- a/notes/setup/index.html +++ b/notes/setup/index.html @@ -1,54 +1,15 @@ -Quartz Example Page
-

Setup

Having problems? -troubleshooting


\ No newline at end of file +Setup
+

Setup

Making your own Quartz

Setting up Quartz requires a basic understanding of git. If you are unfamiliar, +this resource +is a great place to start!

Forking

A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project.

Navigate to the GitHub repository for the Quartz project:

πŸ“ +Quartz Repository

Then, Fork the repository into your own GitHub account. If you don’t have an account, you can make on for free +here +. More details about forking a repo can be found on +GitHub’s documentation +.

Cloning

After you’ve made a fork of the repository, you need to download the files locally onto your machine. Ensure you have git, then type the following command replacing YOUR-USERNAME with your GitHub username.

1
+
$ git clone https://github.com/YOUR-USERNAME/quartz
+

Editing

Great! Now you have everything you need to start editing and growing your digital garden. If you’re ready to start writing content already, check out the recommended flow for editing notes in Quartz.

✏️ +Editing Notes in Quartz

Having problems? Checkout our +FAQ and Troubleshooting guide +.


Interactive Graph

\ No newline at end of file diff --git a/notes/troubleshooting/index.html b/notes/troubleshooting/index.html index fc75f995f..3375cf25b 100644 --- a/notes/troubleshooting/index.html +++ b/notes/troubleshooting/index.html @@ -1,53 +1,3 @@ -Quartz Example Page
-

troubleshooting


\ No newline at end of file +Troubleshooting and FAQ
+

Troubleshooting and FAQ


Interactive Graph

\ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml index 82b80dcda..ae9105315 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -1 +1 @@ -https://quartz.jzhao.xyz/0https://quartz.jzhao.xyz/categories/https://quartz.jzhao.xyz/notes/config/https://quartz.jzhao.xyz/moc/directory/https://quartz.jzhao.xyz/moc/https://quartz.jzhao.xyz/notes/https://quartz.jzhao.xyz/notes/setup/https://quartz.jzhao.xyz/tags/https://quartz.jzhao.xyz/notes/troubleshooting/ \ No newline at end of file +https://quartz.jzhao.xyz/0https://quartz.jzhao.xyz/categories/https://quartz.jzhao.xyz/notes/config/https://quartz.jzhao.xyz/notes/hosting/https://quartz.jzhao.xyz/notes/editing/https://quartz.jzhao.xyz/moc/https://quartz.jzhao.xyz/notes/https://quartz.jzhao.xyz/notes/obsidian/https://quartz.jzhao.xyz/moc/directory/https://quartz.jzhao.xyz/notes/setup/https://quartz.jzhao.xyz/tags/https://quartz.jzhao.xyz/notes/troubleshooting/ \ No newline at end of file