Setup Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have....
2 minute read. Last updated February 11, 2022
\ No newline at end of file
diff --git a/index.html b/index.html
index c17bce129..979d5c038 100644
--- a/index.html
+++ b/index.html
@@ -1,4 +1,4 @@
-šŖ“ Quartz 3
Quartz is designed to be extremely configurable. You can find the bulk of the configuration scattered throughout the repository depending on how in-depth you’d like to get.
The majority of configuration can be be found under data/config.yaml. An annotated example configuration is shown below.
Quartz is designed to be extremely configurable. You can find the bulk of the configuration scattered throughout the repository depending on how in-depth you’d like to get.
The majority of configuration can be be found under data/config.yaml. An annotated example configuration is shown below.
This step is only applicable if you are using a custom domain! If you are using a <YOUR-USERNAME>.github.io domain, you can skip this step.
For this last bit to take effect, you also need to create a CNAME record with the DNS provider you register your domain with (i.e. NameCheap, Google Domains).
GitHub has some
+
Custom Domain
Last updated February 11, 2022
Registrar
This step is only applicable if you are using a custom domain! If you are using a <YOUR-USERNAME>.github.io domain, you can skip this step.
For this last bit to take effect, you also need to create a CNAME record with the DNS provider you register your domain with (i.e. NameCheap, Google Domains).
Go to your forked repository (github.com/<YOUR-GITHUB-USERNAME>/quartz) settings page and go to the Pages tab. Under “Custom domain”, type your custom domain, then click Save.
Go to your DNS Provider and create a CNAME record that points from your domain to <YOUR-GITHUB-USERNAME.github.io. (yes, with the trailing period).
Example Configuration for Quartz
Wait 30 minutes to an hour for the network changes to kick in.
\ No newline at end of file
diff --git a/notes/editing/index.html b/notes/editing/index.html
index 8bc6384d8..a78327d3d 100644
--- a/notes/editing/index.html
+++ b/notes/editing/index.html
@@ -1,5 +1,5 @@
Editing Content in Quartz
Quartz runs on top of
Hugo so all notes are written in
Markdown.
Obsidian
I 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 your local files.
This step is highly recommended.
š
@@ -29,10 +29,12 @@ Obsidian I recommend using Obsidian as a way to edit and grow your digital garde
5
6
7
+8
---
title: "Example Title"
tags:
- example-tag
+disableToc: true # do not show a table of contents on this page if enabled
---
Rest of your content here...
diff --git a/notes/hosting/index.html b/notes/hosting/index.html
index 70a09d348..ebf7fe9ba 100644
--- a/notes/hosting/index.html
+++ b/notes/hosting/index.html
@@ -1,4 +1,4 @@
-Deploying Quartz to the Web
Quartz is designed to be effortless to deploy. If you forked and cloned Quartz directly from the repository, everything should already be good to go! Follow the steps below.
Enable GitHub Actions
By default, GitHub disables workflows from running automatically on Forked Repostories. Head to the ‘Actions’ tab of your forked repository and Enable Workflows to setup deploying your Quartz site!
Enable GitHub Actions
Enable GitHub Pages
Head to the ‘Settings’ tab of your forked repository and go to the ‘Pages’ tab.
(IMPORTANT) Set the source to deploy from master using / (root)
Set a custom domain here if you have one!
Enable GitHub Pages
Pushing Changes
To see your changes on the internet, we need to push it them to GitHub. Quartz is essentially a git repository so updating it is the same workflow as you would follow as normal.
Quartz is designed to be effortless to deploy. If you forked and cloned Quartz directly from the repository, everything should already be good to go! Follow the steps below.
Enable GitHub Actions
By default, GitHub disables workflows from running automatically on Forked Repostories. Head to the ‘Actions’ tab of your forked repository and Enable Workflows to setup deploying your Quartz site!
Enable GitHub Actions
Enable GitHub Pages
Head to the ‘Settings’ tab of your forked repository and go to the ‘Pages’ tab.
(IMPORTANT) Set the source to deploy from master using / (root)
Set a custom domain here if you have one!
Enable GitHub Pages
Pushing Changes
To see your changes on the internet, we need to push it them to GitHub. Quartz is essentially a git repository so updating it is the same workflow as you would follow as normal.
Want to see what Quartz can do? Here are some cool community gardens :)
-Quartz Documentation (this site!) Strengthening Online Social Bonds: Research Garden Jacky Zhao’s Garden Anson Yu’s Garden Shihyu’s PKM Chloe’s Garden SlRvb’s Site Course notes for Information Technology Advanced Theory If you want to see your own on here, submit a Pull Request adding yourself to this file!...
ā[One] who works with the door open gets all kinds of interruptions, but [they] also occasionally gets clues as to what the world is and what might be important....
Editing Quartz runs on top of Hugo so all notes are written in Markdown.
-Obsidian I recommend using Obsidian as a way to edit and grow your digital garden....
GitHub Pages Quartz is designed to be effortless to deploy. If you forked and cloned Quartz directly from the repository, everything should already be good to go!...
Registrar This step is only applicable if you are using a custom domain! If you are using a <YOUR-USERNAME>.github.io domain, you can skip this step....
Configuration Quartz is designed to be extremely configurable. You can find the bulk of the configuration scattered throughout the repository depending on how in-depth you’d like to get....
ā[One] who works with the door open gets all kinds of interruptions, but [they] also occasionally gets clues as to what the world is and what might be important....
Editing Quartz runs on top of Hugo so all notes are written in Markdown.
+Obsidian I recommend using Obsidian as a way to edit and grow your digital garden....
GitHub Pages Quartz is designed to be effortless to deploy. If you forked and cloned Quartz directly from the repository, everything should already be good to go!...
Registrar This step is only applicable if you are using a custom domain! If you are using a <YOUR-USERNAME>.github.io domain, you can skip this step....
Configuration Quartz is designed to be extremely configurable. You can find the bulk of the configuration scattered throughout the repository depending on how in-depth you’d like to get....
\ No newline at end of file
diff --git a/notes/obsidian/index.html b/notes/obsidian/index.html
index 866e75e65..998b82ee7 100644
--- a/notes/obsidian/index.html
+++ b/notes/obsidian/index.html
@@ -1,4 +1,4 @@
-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 Obsidian and create a new Vault in the /content folder that you created and cloned during the
setup step.
Linking an existing Vault
The easiest way to use an existing Vault is to copy all of your files (directory and hierarchies intact) into the /content folder.
Settings
Great, now that you have your Obsidian linked to your Quartz, let’s fix some settings so that they play well.
Under Options > Files and Links, set the New link format to always be Absolute Path in Vault and disabled WikiLinks so Obsidian generates regular Markdown links.
Go to Settings > Files & Links > Turn “on” automatically update internal links.
Use [[Wikilinks]] should be off (Wikilinks are not officially supported yet)
Obsidian Settings
Templates
Inserting front matter everytime you want to create a new Note gets annoying really quickly. Luckily, Obsidian supports templates which makes inserting new content really easily.
If you decide to overwrite the /content folder completely, don’t remove the /content/templates folder!
Head over to Options > Core Plugins and enable the Templates plugin. Then go to Options > Hotkeys and set a hotkey for ‘Insert Template’ (I recomment [cmd]+T). That way, when you create a new note, you can just press the hotkey for a new template and be ready to go!
\ No newline at end of file
diff --git a/notes/page/2/index.html b/notes/page/2/index.html
index 90001e7ba..669435835 100644
--- a/notes/page/2/index.html
+++ b/notes/page/2/index.html
@@ -1,4 +1,4 @@
-Notes
Still having trouble? Here are a list of common questions and problems people encounter when installing Quartz.
-While you’re here, join our Discord :)...
\ No newline at end of file
diff --git a/notes/philosophy/index.html b/notes/philosophy/index.html
index 71fd6303b..2fc4ad741 100644
--- a/notes/philosophy/index.html
+++ b/notes/philosophy/index.html
@@ -1,4 +1,4 @@
-Quartz Philosophy
ā[One] who works with the door open gets all kinds of interruptions, but [they] also occasionally gets clues as to what the world is and what might be important.ā ā Richard Hamming
Why Quartz?
Hosting a public digital garden isn’t easy. There are an overwhelming number of tutorials, resources, and guides for tools like
+
Quartz Philosophy
Last updated February 11, 2022
ā[One] who works with the door open gets all kinds of interruptions, but [they] also occasionally gets clues as to what the world is and what might be important.ā ā Richard Hamming
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
It’s nice to access notes from anywhere
Having a public digital garden invites open conversations
It makes keeping personal notes and knowledge playful and fun
I was really inspired by
diff --git a/notes/preview-changes/index.html b/notes/preview-changes/index.html
index 50e55f442..48ddf2495 100644
--- a/notes/preview-changes/index.html
+++ b/notes/preview-changes/index.html
@@ -1,4 +1,4 @@
-
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
diff --git a/notes/showcase/index.html b/notes/showcase/index.html
index 3e2a94ec9..0d836dc53 100644
--- a/notes/showcase/index.html
+++ b/notes/showcase/index.html
@@ -1,5 +1,5 @@
\ No newline at end of file
diff --git a/notes/troubleshooting/index.html b/notes/troubleshooting/index.html
index 5e9493e8c..7238d3048 100644
--- a/notes/troubleshooting/index.html
+++ b/notes/troubleshooting/index.html
@@ -1,5 +1,5 @@
Troubleshooting and FAQ
Some of my pages have ‘January 1, 0001’ as the last modified date
This is a problem caused by git treating files as case-insensitive by default and some of your posts probably have capitalized file names. You can turn this off in your Quartz by running this command.
1
2
3
diff --git a/sitemap.xml b/sitemap.xml
index a8e2e88cc..d01b36495 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -1 +1 @@
-https://quartz.jzhao.xyz/categories/https://quartz.jzhao.xyz/notes/config/2022-01-31T12:28:40-08:00https://quartz.jzhao.xyz/notes/custom-Domain/2022-01-31T12:28:40-08:00https://quartz.jzhao.xyz/notes/hosting/2022-01-31T12:28:40-08:00https://quartz.jzhao.xyz/notes/editing/2022-01-31T12:28:40-08:00https://quartz.jzhao.xyz/notes/ignore-notes/2022-01-31T12:28:40-08:00https://quartz.jzhao.xyz/notes/2022-01-31T12:28:40-08:00https://quartz.jzhao.xyz/notes/obsidian/2022-01-31T12:28:40-08:00https://quartz.jzhao.xyz/notes/preview-changes/2022-01-31T12:28:40-08:00https://quartz.jzhao.xyz/notes/philosophy/2022-01-31T12:28:40-08:00https://quartz.jzhao.xyz/notes/setup/2022-01-31T12:28:40-08:00https://quartz.jzhao.xyz/tags/setup/2022-01-31T12:28:40-08:00https://quartz.jzhao.xyz/notes/showcase/2022-01-31T12:28:40-08:00https://quartz.jzhao.xyz/tags/2022-01-31T12:28:40-08:00https://quartz.jzhao.xyz/notes/troubleshooting/2022-01-31T12:28:40-08:00https://quartz.jzhao.xyz/2022-01-31T12:28:40-08:00
\ No newline at end of file
+https://quartz.jzhao.xyz/categories/https://quartz.jzhao.xyz/notes/config/2022-02-11T17:24:54-05:00https://quartz.jzhao.xyz/notes/custom-Domain/2022-02-11T17:24:54-05:00https://quartz.jzhao.xyz/notes/hosting/2022-02-11T17:24:54-05:00https://quartz.jzhao.xyz/notes/editing/2022-02-11T17:24:54-05:00https://quartz.jzhao.xyz/notes/ignore-notes/2022-02-11T17:24:54-05:00https://quartz.jzhao.xyz/notes/2022-02-11T17:24:54-05:00https://quartz.jzhao.xyz/notes/obsidian/2022-02-11T17:24:54-05:00https://quartz.jzhao.xyz/notes/preview-changes/2022-02-11T17:24:54-05:00https://quartz.jzhao.xyz/notes/philosophy/2022-02-11T17:24:54-05:00https://quartz.jzhao.xyz/notes/setup/2022-02-11T17:24:54-05:00https://quartz.jzhao.xyz/tags/setup/2022-02-11T17:24:54-05:00https://quartz.jzhao.xyz/notes/showcase/2022-02-11T17:24:54-05:00https://quartz.jzhao.xyz/tags/2022-02-11T17:24:54-05:00https://quartz.jzhao.xyz/notes/troubleshooting/2022-02-11T17:24:54-05:00https://quartz.jzhao.xyz/2022-02-11T17:24:54-05:00
\ No newline at end of file
diff --git a/tags/index.html b/tags/index.html
index 53f7eb42d..6b6c64d50 100644
--- a/tags/index.html
+++ b/tags/index.html
@@ -1,4 +1,4 @@
-Tags
Setup Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have....
2 minute read. Last updated February 11, 2022
\ No newline at end of file
diff --git a/tags/setup/index.html b/tags/setup/index.html
index 87a8cc448..c6481877e 100644
--- a/tags/setup/index.html
+++ b/tags/setup/index.html
@@ -1,4 +1,4 @@
-setup
Configuration Quartz is designed to be extremely configurable. You can find the bulk of the configuration scattered throughout the repository depending on how in-depth you’d like to get....
GitHub Pages Quartz is designed to be effortless to deploy. If you forked and cloned Quartz directly from the repository, everything should already be good to go!...
Editing Quartz runs on top of Hugo so all notes are written in Markdown.
-Obsidian I recommend using Obsidian as a way to edit and grow your digital garden....
Configuration Quartz is designed to be extremely configurable. You can find the bulk of the configuration scattered throughout the repository depending on how in-depth you’d like to get....
GitHub Pages Quartz is designed to be effortless to deploy. If you forked and cloned Quartz directly from the repository, everything should already be good to go!...
Editing Quartz runs on top of Hugo so all notes are written in Markdown.
+Obsidian I recommend using Obsidian as a way to edit and grow your digital garden....
Example Configuration for Quartz
Enable GitHub Actions
Enable GitHub Pages
Obsidian Settings