\ No newline at end of file
diff --git a/index.html b/index.html
index 3417f8d92..d1f01df55 100644
--- a/index.html
+++ b/index.html
@@ -1,7 +1,7 @@
-šŖ“ Quartz v2.1
šŖ“ Quartz v2.1
Host your second brain and
@@ -13,4 +13,4 @@ built with Quartz, or read about
why I made Quartz
to begin with!
\ No newline at end of file
diff --git a/moc/showcase/index.html b/moc/showcase/index.html
index 324e6ec5c..78f886138 100644
--- a/moc/showcase/index.html
+++ b/moc/showcase/index.html
@@ -1,10 +1,10 @@
-Showcase
Showcase
-
Want to see what Quartz can do? Here are some cool community gardens :)
\ No newline at end of file
diff --git a/notes/config/index.html b/notes/config/index.html
index a196bacdc..2b9bcc635 100644
--- a/notes/config/index.html
+++ b/notes/config/index.html
@@ -1,10 +1,10 @@
-Configuration
Configuration
-
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.
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
@@ -37,5 +37,5 @@
Styling
Want to go even more in-depth? You can add custom CSS styling and change existing colours through editing assets/custom.scss. If you’d like to target specific parts of the site, you can add ids and classes to the HTML partials in /layouts/partials.
Partials
Partials are what dictate what actually gets rendered to the page. Want to change how pages are styled and structured? You can edit the appropriate layout in /layouts.
For example, the structure of the home page can be edited through /layouts/index.html. To customize the footer, you can edit /layouts/partials/footer.html
\ No newline at end of file
diff --git a/notes/editing/index.html b/notes/editing/index.html
index 03b1a48ad..2d8a16d2e 100644
--- a/notes/editing/index.html
+++ b/notes/editing/index.html
@@ -1,10 +1,10 @@
-Editing Content in Quartz
\ No newline at end of file
diff --git a/notes/hosting/index.html b/notes/hosting/index.html
index 1dc79a24e..e9a3bc2b5 100644
--- a/notes/hosting/index.html
+++ b/notes/hosting/index.html
@@ -1,10 +1,10 @@
-Deploying Quartz to the Web
Deploying Quartz to the Web
-
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! You can head to <YOUR-GITHUB-USERNAME.github.io/quartz to see it live.
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.
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! You can head to <YOUR-GITHUB-USERNAME.github.io/quartz to see it live.
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.
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.
1
2
3
4
@@ -22,9 +22,11 @@ git commit -m "message describing changes"# Push to GitHub to update site
git push origin hugo
-
Setting up the Site
Now let’s get this site up and running. Never hosted a site before? No problem. Have a fancy custom domain you already own or want to subdomain your Quartz? That’s easy too.
Here, we take advantage of GitHub’s free page hosting to deploy our site. Change baseURL in /config.toml. If you don’t have a custom domain to use, you can use <YOUR-USERNAME>.github.io (which GitHub gives to you for free!) as your domain.
Now let’s get this site up and running. Never hosted a site before? No problem. Have a fancy custom domain you already own or want to subdomain your Quartz? That’s easy too.
Here, we take advantage of GitHub’s free page hosting to deploy our site. Change baseURL in /config.toml. If you don’t have a custom domain to use, you can use <YOUR-USERNAME>.github.io (which GitHub gives to you for free!) as your domain.
1
2
3
4
@@ -43,5 +45,5 @@ git push origin hugo
, 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!
External Hosting
Don’t want to use GitHub Pages? Hugo builds everything for you! Everything is a packaged set of static files ready to deploy in /public. You can then upload this folder to a cloud provider to deploy. Alternatively, most providers also give users the option to link a GitHub repository and a folder to deploy. When doing this, ensure you select /public folder under the master branch.
Now that your Quartz is live, let’s figure out how to make Quartz really yours!
\ No newline at end of file
diff --git a/notes/ignore-notes/index.html b/notes/ignore-notes/index.html
index 739b0e3c0..236379269 100644
--- a/notes/ignore-notes/index.html
+++ b/notes/ignore-notes/index.html
@@ -1,10 +1,10 @@
-Ignoring Notes
Ignoring Notes
-
Quartz Ignore
Edit ignoreFiles in config.toml to include paths you’d like to exclude from being rendered.
However, just adding to the ignoreFiles will only prevent the page from being access through Quartz. If you want to prevent the file from being pushed to GitHub (for example if you have a public repository), you need to also add the path to the .gitignore file at the root of the repository.
\ No newline at end of file
diff --git a/notes/obsidian/index.html b/notes/obsidian/index.html
index f213c85d8..1e9376723 100644
--- a/notes/obsidian/index.html
+++ b/notes/obsidian/index.html
@@ -1,12 +1,12 @@
-Obsidian Vault Integration
Obsidian Vault Integration
-
Setup
Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have.
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
-.
Linking an existing Vault
The easiest way to use an existing Vault is to copy all of our 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.
Obsidian Settings
Templates
Inserting front matter everytime you want to create a new Note gets really 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’. 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/philosophy/index.html b/notes/philosophy/index.html
index 8b3fb0259..445c459d0 100644
--- a/notes/philosophy/index.html
+++ b/notes/philosophy/index.html
@@ -1,10 +1,10 @@
-Quartz Philosophy
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
+
ā[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
@@ -14,5 +14,5 @@
Bianca
and
Joel
-’s digital gardens and wanted to try making my own.
The goal of Quartz is to make hosting your own public digital garden free and simple. You don’t even need your own website. Quartz does all of that for you and gives your own little corner of the internet.
\ No newline at end of file
diff --git a/notes/preview-changes/index.html b/notes/preview-changes/index.html
index ae090c9b1..652a9b98b 100644
--- a/notes/preview-changes/index.html
+++ b/notes/preview-changes/index.html
@@ -1,10 +1,10 @@
-Preview Changes
Preview Changes
-
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!
Install hugo-obsidian
This step will generate the list of backlinks for Hugo to parse. Ensure you have
+
\ No newline at end of file
diff --git a/notes/setup/index.html b/notes/setup/index.html
index ecd51b575..56cb18be3 100644
--- a/notes/setup/index.html
+++ b/notes/setup/index.html
@@ -1,10 +1,10 @@
-Setup
Setup
-
Making your own Quartz
Setting up Quartz requires a basic understanding of git. If you are unfamiliar,
+
Then, Fork the repository into your own GitHub account. If you don’t have an account, you can make on for free
@@ -16,5 +16,5 @@ is a great place to start!
Forking
A fork i
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.
\ No newline at end of file
diff --git a/notes/troubleshooting/index.html b/notes/troubleshooting/index.html
index 26699cfcf..133158c2a 100644
--- a/notes/troubleshooting/index.html
+++ b/notes/troubleshooting/index.html
@@ -1,10 +1,10 @@
-Troubleshooting and FAQ
Troubleshooting and FAQ
-
Common Pitfalls
Can I publish only a subset of my pages?
Yes! Quartz makes selective publishing really easy. Heres a guide on
+
Yes! All built files can be found under /public in the master branch. More details under
hosting
@@ -36,5 +36,5 @@ again. Make sure you wait 30 min to 1 hour for changes to take effect.
local editing
Can I use React/Vue/some other framework?
Not out of the box. You could probably make it work by editing /layouts/_default/single.html but that’s not what Quartz is designed to work with. 99% of things you are trying to do with those frameworks you can accomplish perfectly fine using just vanilla HTML/CSS/JS.
Still Stuck?
Quartz isn’t perfect! If you’re still having troubles, file an issue in the GitHub repo with as much information as you can reasonably provide. Alternatively, you can message me on
Twitter
and I’ll try to get back to you as soon as I can.