1
+Configuration Search Icon Icon to open search
Configuration Last updated March 9, 2022
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.
The majority of configuration can be be found under data/config.yaml. An annotated example configuration is shown below.
1
2
3
4
diff --git a/notes/custom-Domain/index.html b/notes/custom-Domain/index.html
index 9ab0ae66c..bf7c33f15 100644
--- a/notes/custom-Domain/index.html
+++ b/notes/custom-Domain/index.html
@@ -1,4 +1,4 @@
-Custom Domain Search Icon Icon to open search
Custom Domain Last updated March 7, 2022
Table of Contents Registrar 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).
GitHub has some
+
Custom Domain Search Icon Icon to open search
Custom Domain Last updated March 9, 2022
Table of Contents Registrar 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).
GitHub has some
documentation on this , but the tldr; is to
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.
Done!
Editing Content in Quartz Search Icon Icon to open search
Editing Content in Quartz Last updated March 7, 2022
Editing Quartz runs on top of
+Obsidian I recommend using Obsidian as a way to edit and grow your digital garden.">
Editing Content in Quartz Search Icon Icon to open search
Editing Content in Quartz Last updated March 9, 2022
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. It comes with a really nice editor and graphical interface to preview all of your local files.
This step is highly recommended .
🔗
diff --git a/notes/hosting/index.html b/notes/hosting/index.html
index 771d47a03..bfb94c02b 100644
--- a/notes/hosting/index.html
+++ b/notes/hosting/index.html
@@ -1,5 +1,5 @@
-
Deploying Quartz to the Web Search Icon Icon to open search
Deploying Quartz to the Web Last updated March 7, 2022
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! 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 (and not hugo) 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 a git repository so updating it is the same workflow as you would follow as if it were just a regular software project.
1
+Deploying Quartz to the Web Search Icon Icon to open search
Deploying Quartz to the Web Last updated March 9, 2022
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! 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 (and not hugo) 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 a git repository so updating it is the same workflow as you would follow as if it were just a regular software project.
1
2
3
4
diff --git a/notes/ignore-notes/index.html b/notes/ignore-notes/index.html
index 913eada9e..d2049ae7f 100644
--- a/notes/ignore-notes/index.html
+++ b/notes/ignore-notes/index.html
@@ -1,6 +1,6 @@
Ignoring Notes Search Icon Icon to open search
Ignoring Notes Last updated March 7, 2022
Quartz Ignore Edit ignoreFiles in config.toml to include paths you’d like to exclude from being rendered.
1
+1 2 3 4 5 6 .">Ignoring Notes Search Icon Icon to open search
Ignoring Notes Last updated March 9, 2022
Quartz Ignore Edit ignoreFiles in config.toml to include paths you’d like to exclude from being rendered.
1
2
3
4
diff --git a/notes/index.html b/notes/index.html
index 124e635d7..372adaa52 100644
--- a/notes/index.html
+++ b/notes/index.html
@@ -1,6 +1,6 @@
-Notes Search Icon Icon to open search
+
Notes Search Icon Icon to open search
All Notes 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 Brandon Boswell’s Garden If you want to see your own on here, submit a Pull Request adding yourself to this file!...
1 minute read. Last updated March 7, 2022
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!...
1 minute read. Last updated March 7, 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....
1 minute read. Last updated March 7, 2022
If you’d like to preview what your Quartz site looks like before deploying it to the internet, here’s exactly how to do that!...
1 minute read. Last updated March 7, 2022
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 March 7, 2022
Quartz Ignore Edit ignoreFiles in config.toml to include paths you’d like to exclude from being rendered.
-1 2 3 4 5 6 ....
1 minute read. Last updated March 7, 2022
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....
2 minute read. Last updated March 7, 2022
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!...
2 minute read. Last updated March 7, 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....
1 minute read. Last updated March 7, 2022
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....
2 minute read. Last updated March 7, 2022
1 minute read. Last updated March 9, 2022
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!...
1 minute read. Last updated March 9, 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....
1 minute read. Last updated March 9, 2022
If you’d like to preview what your Quartz site looks like before deploying it to the internet, here’s exactly how to do that!...
1 minute read. Last updated March 9, 2022
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 March 9, 2022
Quartz Ignore Edit ignoreFiles in config.toml to include paths you’d like to exclude from being rendered.
+1 2 3 4 5 6 ....
1 minute read. Last updated March 9, 2022
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....
2 minute read. Last updated March 9, 2022
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!...
2 minute read. Last updated March 9, 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....
1 minute read. Last updated March 9, 2022
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....
2 minute read. Last updated March 9, 2022
Obsidian Vault Integration Search Icon Icon to open search
Obsidian Vault Integration Last updated March 7, 2022
Setup 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,
+
Obsidian Vault Integration Search Icon Icon to open search
Obsidian Vault Integration Last updated March 9, 2022
Setup 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!
Notes Search Icon Icon to open search
+
Notes Search Icon Icon to open search
All 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 :)...
3 minute read. Last updated March 7, 2022
3 minute read. Last updated March 9, 2022
Quartz Philosophy Search Icon Icon to open search
Quartz Philosophy Last updated March 7, 2022
Table of Contents Why Quartz? “[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 Search Icon Icon to open search
Quartz Philosophy Last updated March 9, 2022
Table of Contents Why Quartz? “[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 3d3ed9302..92a774c5a 100644
--- a/notes/preview-changes/index.html
+++ b/notes/preview-changes/index.html
@@ -1,5 +1,5 @@
-
Preview Changes Search Icon Icon to open search
Preview Changes Last updated March 7, 2022
If you’d like to preview what your Quartz site looks like before deploying it to the internet, here’s exactly how to do that!
Note that both of these steps need to be completed.
Install hugo-obsidian This step will generate the list of backlinks for Hugo to parse. Ensure you have
+
Preview Changes Search Icon Icon to open search
Preview Changes Last updated March 9, 2022
If you’d like to preview what your Quartz site looks like before deploying it to the internet, here’s exactly how to do that!
Note that both of these steps need to be completed.
Install hugo-obsidian This step will generate the list of backlinks for Hugo to parse. Ensure you have
Go (>= 1.16) installed.
1
2
3
diff --git a/notes/setup/index.html b/notes/setup/index.html
index bed03233a..fd11ea19a 100644
--- a/notes/setup/index.html
+++ b/notes/setup/index.html
@@ -1,5 +1,5 @@
-Setup Search Icon Icon to open search
Setup Last updated March 7, 2022
Making your own Quartz Setting up Quartz requires a basic understanding of git. If you are unfamiliar,
+
Setup Search Icon Icon to open search
Setup Last updated March 9, 2022
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
diff --git a/notes/showcase/index.html b/notes/showcase/index.html
index 7970b74b3..13c053160 100644
--- a/notes/showcase/index.html
+++ b/notes/showcase/index.html
@@ -1,5 +1,5 @@
Showcase Search Icon Icon to open search
Showcase Last updated March 7, 2022
Want to see what Quartz can do? Here are some cool community gardens :)
If you want to see your own on here, submit a
+ 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 Brandon Boswell’s Garden If you want to see your own on here, submit a Pull Request adding yourself to this file!">
Showcase Search Icon Icon to open search
Showcase Last updated March 9, 2022
Want to see what Quartz can do? Here are some cool community gardens :)
If you want to see your own on here, submit a
Pull Request adding yourself to this file !
Troubleshooting and FAQ Search Icon Icon to open search
Troubleshooting and FAQ Last updated March 7, 2022
Still having trouble? Here are a list of common questions and problems people encounter when installing Quartz.
While you’re here, join our
+While you’re here, join our Discord :)">
Troubleshooting and FAQ Search Icon Icon to open search
Troubleshooting and FAQ Last updated March 9, 2022
Still having trouble? Here are a list of common questions and problems people encounter when installing Quartz.
While you’re here, join our
Discord :)
My GitHub pages is just showing the README and not Quartz Make sure you set the source to deploy from master (and not hugo) using / (root)! See more in the
hosting guide
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
diff --git a/sitemap.xml b/sitemap.xml
index 90d86316e..b3815741f 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -1 +1 @@
-https://quartz.jzhao.xyz/categories/ https://quartz.jzhao.xyz/notes/config/ 2022-03-07T10:45:07-08:00 https://quartz.jzhao.xyz/notes/custom-Domain/ 2022-03-07T10:45:07-08:00 https://quartz.jzhao.xyz/notes/hosting/ 2022-03-07T10:45:07-08:00 https://quartz.jzhao.xyz/notes/editing/ 2022-03-07T10:45:07-08:00 https://quartz.jzhao.xyz/notes/ignore-notes/ 2022-03-07T10:45:07-08:00 https://quartz.jzhao.xyz/notes/ 2022-03-07T10:45:07-08:00 https://quartz.jzhao.xyz/notes/obsidian/ 2022-03-07T10:45:07-08:00 https://quartz.jzhao.xyz/notes/preview-changes/ 2022-03-07T10:45:07-08:00 https://quartz.jzhao.xyz/notes/philosophy/ 2022-03-07T10:45:07-08:00 https://quartz.jzhao.xyz/notes/setup/ 2022-03-07T10:45:07-08:00 https://quartz.jzhao.xyz/tags/setup/ 2022-03-07T10:45:07-08:00 https://quartz.jzhao.xyz/notes/showcase/ 2022-03-07T10:45:07-08:00 https://quartz.jzhao.xyz/tags/ 2022-03-07T10:45:07-08:00 https://quartz.jzhao.xyz/notes/troubleshooting/ 2022-03-07T10:45:07-08:00 https://quartz.jzhao.xyz/ 2022-03-07T10:45:07-08:00 https://quartz.jzhao.xyz/categories/ https://quartz.jzhao.xyz/notes/config/ 2022-03-09T10:11:36-08:00 https://quartz.jzhao.xyz/notes/custom-Domain/ 2022-03-09T10:11:36-08:00 https://quartz.jzhao.xyz/notes/hosting/ 2022-03-09T10:11:36-08:00 https://quartz.jzhao.xyz/notes/editing/ 2022-03-09T10:11:36-08:00 https://quartz.jzhao.xyz/notes/ignore-notes/ 2022-03-09T10:11:36-08:00 https://quartz.jzhao.xyz/notes/ 2022-03-09T10:11:36-08:00 https://quartz.jzhao.xyz/notes/obsidian/ 2022-03-09T10:11:36-08:00 https://quartz.jzhao.xyz/notes/preview-changes/ 2022-03-09T10:11:36-08:00 https://quartz.jzhao.xyz/notes/philosophy/ 2022-03-09T10:11:36-08:00 https://quartz.jzhao.xyz/notes/setup/ 2022-03-09T10:11:36-08:00 https://quartz.jzhao.xyz/tags/setup/ 2022-03-09T10:11:36-08:00 https://quartz.jzhao.xyz/notes/showcase/ 2022-03-09T10:11:36-08:00 https://quartz.jzhao.xyz/tags/ 2022-03-09T10:11:36-08:00 https://quartz.jzhao.xyz/notes/troubleshooting/ 2022-03-09T10:11:36-08:00 https://quartz.jzhao.xyz/ 2022-03-09T10:11:36-08:00 Tags Search Icon Icon to open search
All Tags