diff --git a/404.html b/404.html index 839fcdc6e..19fadc833 100644 --- a/404.html +++ b/404.html @@ -1,2 +1,2 @@ -404 Page not found
-

404.

Hey! You look a little lost.

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

404.

Hey! You look a little lost. This page doesn't exist (or may be private).

↳ Let's get you home.
\ No newline at end of file diff --git a/index.html b/index.html index d3b5ef395..07d27a62e 100644 --- a/index.html +++ b/index.html @@ -1,5 +1,5 @@ -Quartz Example Page
-

🌱 Quartz

Simple second brain and +Quartz Example Page

+

🌱 Quartz

v1.1

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 @@ -12,4 +12,4 @@ 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.

Get Started

The entire Quartz documentation is fully hosted using Quartz! To get started, let’s visit the main directory.

👉 -Directory

Backlinks

  • No backlinks found

Interactive Graph

\ No newline at end of file +Directory

Backlinks

  • No backlinks found

Interactive Graph

\ No newline at end of file diff --git a/index.xml b/index.xml index 922a88d2e..7cc20eab2 100644 --- a/index.xml +++ b/index.xml @@ -1,18 +1,23 @@ <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/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&rsquo;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 5 6 7 8 9 10 name:Your name here!# Shows in the footerenableToc:true# Whether to show a Table of Contentsdescription:Page description to show to search enginespage_title:Quartz Example Page# Default Page Titlelinks:# Links to show in footer- link_name:Twitterlink:https://twitter.Deploying to GitHub Pageshttps://quartz.jzhao.xyz/notes/hosting/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/hosting/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 &lt;YOUR-GITHUB-USERNAME.github.io/quartz to see it live. +1 2 3 4 5 6 7 8 9 10 name:Your name here!# Shows in the footerenableToc:true# Whether to show a Table of Contentsdescription:Page description to show to search enginespage_title:Quartz Example Page# Default Page Titlelinks:# Links to show in footer- link_name:Twitterlink:https://twitter.Deploying Quartz to the Webhttps://quartz.jzhao.xyz/notes/hosting/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/hosting/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 &lt;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 &lsquo;Actions&rsquo; tab of your forked repository and Enable Workflows to setup deploying your Quartz site! Enable GitHub ActionsEditing 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 . 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&rsquo;m not going to stop you!Obsidian Vault Integrationhttps://quartz.jzhao.xyz/notes/obsidian/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/obsidian/Setup Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have. +Of course, all the files are in Markdown so you could just use your favourite text editor of choice.External Hostinghttps://quartz.jzhao.xyz/notes/external-hosting/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/external-hosting/Ignoring Noteshttps://quartz.jzhao.xyz/notes/ignore-notes/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/ignore-notes/Quartz Ignore Edit ignoreFiles in config.toml to include paths you&rsquo;d like to exclude from being rendered. +1 2 3 4 5 6 ... ignoreFiles = [ &#34;/content/templates/*&#34;, &#34;/content/private/*&#34;, &#34;&lt;your path here&gt;&#34; ] ignoreFiles supports the use of Regular Expressions (RegEx) so you can ignore patterns as well (e.g. ignoring all .pngs by doing \\.png$). +More details in Hugo&rsquo;s documentation . +Global Ignore However, just adding to the ignoreFiles will only prevent the page from being access through Quartz.Obsidian Vault Integrationhttps://quartz.jzhao.xyz/notes/obsidian/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/obsidian/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&rsquo;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.Quartz 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. +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.Preview Changeshttps://quartz.jzhao.xyz/notes/preview-changes/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/preview-changes/If you&rsquo;d like to preview what your Quartz site looks like before deploying it to the internet, here&rsquo;s exactly how to do that! +Install hugo-obsidian This step will generate the list of backlinks for Hugo to parse. Ensure you have Go (&gt;= 1.16) installed. +1 2 3 4 5 6 7 8 # Install and link `hugo-obsidian` locally $ go install github.com/jackyzha0/hugo-obsidian # Navigate to your local Quartz folder $ cd &lt;location-of-your-local-quartz&gt; # 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!Quartz 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! Not convinced yet?Setuphttps://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.Showcasehttps://quartz.jzhao.xyz/moc/showcase/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/moc/showcase/Want to see what Quartz can do? Here are some cool community gardens :) -Quartz Documentation (this site!) Jacky Zhao&rsquo;s Garden If you want to see your own on here, submit a Pull Request adding yourself to this file !Troubleshooting and FAQhttps://quartz.jzhao.xyz/notes/troubleshooting/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/troubleshooting/Common Pitfalls Do I need a website already? No! Setting up Quartz means you set up a site too :) -command not found: hugo-obsidian Make sure you set your GOPATH correctly! This will allow your terminal to correctly recognize hugo-obsidian as an executable. -1 2 3 4 5 6 # Add the following 2 lines to your ~/.bash_profile export GOPATH=/Users/$USER/go export PATH=$GOPATH/bin:$PATH # In your current terminal, to reload the session source ~/. \ No newline at end of file +Quartz Documentation (this site!) Jacky Zhao Anson Yu If you want to see your own on here, submit a Pull Request adding yourself to this file !Troubleshooting and FAQhttps://quartz.jzhao.xyz/notes/troubleshooting/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/troubleshooting/Common Pitfalls Can I publish only a subset of my pages? Yes! Quartz makes selective publishing really easy. Heres a guide on excluding pages from being published . +Can I host this myself and not on GitHub Pages? Yes! All built files can be found under /public in the master branch. More details under hosting . +Do I need a website already? No! Setting up Quartz means you set up a site too :) \ No newline at end of file diff --git a/moc/directory/index.html b/moc/directory/index.html index 5ec3b35ad..6d2452d43 100644 --- a/moc/directory/index.html +++ b/moc/directory/index.html @@ -1,11 +1,11 @@ -Quartz Documentation
+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!

Not convinced yet? Look at some -cool community digital gardens -!

Troubleshooting

Backlinks

Interactive Graph

Made by Jacky Zhao using Quartz, © 2021

Home +Submit an Issue

Backlinks

Interactive Graph

\ No newline at end of file diff --git a/moc/index.xml b/moc/index.xml index fdd584664..e9174f902 100644 --- a/moc/index.xml +++ b/moc/index.xml @@ -1,4 +1,4 @@ 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! Not convinced yet?Showcasehttps://quartz.jzhao.xyz/moc/showcase/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/moc/showcase/Want to see what Quartz can do? Here are some cool community gardens :) -Quartz Documentation (this site!) Jacky Zhao&rsquo;s Garden If you want to see your own on here, submit a Pull Request adding yourself to this file ! \ No newline at end of file +Quartz Documentation (this site!) Jacky Zhao Anson Yu If you want to see your own on here, submit a Pull Request adding yourself to this file ! \ No newline at end of file diff --git a/moc/showcase/index.html b/moc/showcase/index.html index af8c94d58..c239d6165 100644 --- a/moc/showcase/index.html +++ b/moc/showcase/index.html @@ -1,5 +1,5 @@ -Showcase
-

Showcase

Want to see what Quartz can do? Here are some cool community gardens :)

If you want to see your own on here, submit a +Showcase

+

Backlinks

Interactive Graph

Backlinks

Interactive Graph

\ No newline at end of file diff --git a/notes/config/index.html b/notes/config/index.html index d04fa7e8a..6a080c5f9 100644 --- a/notes/config/index.html +++ b/notes/config/index.html @@ -1,4 +1,4 @@ -Configuration
+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.

 1
  2
  3
@@ -32,5 +32,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

More info about partials on Hugo’s website.

Still having problems? Checkout our FAQ and Troubleshooting guide -.

Backlinks

Interactive Graph

Made by Jacky Zhao using Quartz, © 2021

Home +.

Backlinks

Interactive Graph

\ No newline at end of file diff --git a/notes/editing/index.html b/notes/editing/index.html index cb1794f80..1b3027ede 100644 --- a/notes/editing/index.html +++ b/notes/editing/index.html @@ -1,12 +1,13 @@ -Editing Content in Quartz
-

Editing Content in Quartz

Editing

Quartz runs on top of +Editing Content in Quartz

+

Editing Content in Quartz

Editing

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

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!

Folder Structure

Here’s a rough overview of what’s what.

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 edit the main home page, open /content/_index.md. This is the home page which is slightly special. You don’t need front matter here!

To create a link between notes in your garden, 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
+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.
Ignoring Files
Only want to publish a subset of all of your notes? Don’t worry, Quartz makes this a simple two-step process.
❌
+Excluding pages from being published
Folder Structure
Here’s a rough overview of what’s what.
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 edit the main home page, open /content/_index.md. This is the home page which is slightly special. You don’t need front matter here!
To create a link between notes in your garden, 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 `notes/config.md`.
 [A link to the config page](notes/config.md)
@@ -20,42 +21,9 @@ title: "Example Title"
 ---
 
 Rest of your content here...
-
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.
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
-4
-5
-6
-7
-8
-
# Install and link `hugo-obsidian` locally
-$ go install github.com/jackyzha0/hugo-obsidian
-
-# 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!
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/
-
Publishing Changes
Now that you know the basics of managing your digital garden using Quartz, you can publish it to the internet!
🌍
+

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. This is highly recommended.

👀 +Preview Quartz Changes

For those who like to live life more on the edge, viewing the garden through Obsidian gets you pretty close to the real thing.

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 -.

Backlinks

Interactive Graph

Backlinks

Interactive Graph

\ No newline at end of file diff --git a/notes/external-hosting/index.html b/notes/external-hosting/index.html new file mode 100644 index 000000000..29fd101ec --- /dev/null +++ b/notes/external-hosting/index.html @@ -0,0 +1,3 @@ +External Hosting
+

External Hosting

Backlinks

  • No backlinks found

Interactive Graph

\ No newline at end of file diff --git a/notes/hosting/index.html b/notes/hosting/index.html index 3bbe325ff..b7ec65536 100644 --- a/notes/hosting/index.html +++ b/notes/hosting/index.html @@ -1,5 +1,5 @@ -Deploying to GitHub Pages
-

Deploying to GitHub Pages

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 ActionsEnable GitHub Actions

Enable GitHub Pages

Head to the ‘Settings’ tab of your forked repository and go to the ‘Pages’ tab.

  1. Set the source to deploy from master using / (root)
  2. Set a custom domain here if you have one!

Enable GitHub PagesEnable 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
+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 ActionsEnable GitHub Actions
Enable GitHub Pages
Head to the ‘Settings’ tab of your forked repository and go to the ‘Pages’ tab.
  1. Set the source to deploy from master using / (root)
  2. Set a custom domain here if you have one!
Enable GitHub PagesEnable 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
@@ -35,8 +35,8 @@ git push origin hugo
 	cname: <YOUR-DOMAIN>
 
Registrar
This step is only applicable if you are using a custom domain! If you are using <YOUR-USERNAME>.github.io, 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
  1. 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.
  2. 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 QuartzExample Configuration for Quartz
  3. Wait 30 minutes to an hour for the network changes to kick in.
  4. Done!
Now that your Quartz is live, let’s figure out how to make Quartz really yours!
🎨
+, but the tldr; is to
  1. 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.
  2. 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 QuartzExample Configuration for Quartz
  3. Wait 30 minutes to an hour for the network changes to kick in.
  4. 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!
🎨
 Customizing Quarts
Having problems? Checkout our
 FAQ and Troubleshooting guide
-.
Backlinks
Interactive Graph
Made by Jacky Zhao using Quartz, © 2021
Home
+.
Backlinks
Interactive Graph

\ No newline at end of file
diff --git a/notes/ignore-notes/index.html b/notes/ignore-notes/index.html
new file mode 100644
index 000000000..f84e8f5bc
--- /dev/null
+++ b/notes/ignore-notes/index.html
@@ -0,0 +1,17 @@
+Ignoring Notes

+
Ignoring Notes
Quartz Ignore
Edit ignoreFiles in config.toml to include paths you’d like to exclude from being rendered.
1
+2
+3
+4
+5
+6
+
...
+ignoreFiles = [  
+    "/content/templates/*",  
+    "/content/private/*", 
+	"<your path here>"
+]
+
ignoreFiles supports the use of Regular Expressions (RegEx) so you can ignore patterns as well (e.g. ignoring all .pngs by doing \\.png$).
More details in
+Hugo’s documentation
+.
Global Ignore
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.
Backlinks
Interactive Graph

\ No newline at end of file
diff --git a/notes/index.xml b/notes/index.xml
index f9557e0e7..1d057f0ee 100644
--- a/notes/index.xml
+++ b/notes/index.xml
@@ -1,15 +1,20 @@
 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/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&rsquo;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 5 6 7 8 9 10 name:Your name here!# Shows in the footerenableToc:true# Whether to show a Table of Contentsdescription:Page description to show to search enginespage_title:Quartz Example Page# Default Page Titlelinks:# Links to show in footer- link_name:Twitterlink:https://twitter.Deploying to GitHub Pageshttps://quartz.jzhao.xyz/notes/hosting/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/hosting/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 &lt;YOUR-GITHUB-USERNAME.github.io/quartz to see it live.
+1 2 3 4 5 6 7 8 9 10 name:Your name here!# Shows in the footerenableToc:true# Whether to show a Table of Contentsdescription:Page description to show to search enginespage_title:Quartz Example Page# Default Page Titlelinks:# Links to show in footer- link_name:Twitterlink:https://twitter.Deploying Quartz to the Webhttps://quartz.jzhao.xyz/notes/hosting/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/hosting/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 &lt;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 &lsquo;Actions&rsquo; tab of your forked repository and Enable Workflows to setup deploying your Quartz site!
 Enable GitHub ActionsEditing 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 .
 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&rsquo;m not going to stop you!Obsidian Vault Integrationhttps://quartz.jzhao.xyz/notes/obsidian/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/obsidian/Setup Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have.
+Of course, all the files are in Markdown so you could just use your favourite text editor of choice.External Hostinghttps://quartz.jzhao.xyz/notes/external-hosting/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/external-hosting/Ignoring Noteshttps://quartz.jzhao.xyz/notes/ignore-notes/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/ignore-notes/Quartz Ignore Edit ignoreFiles in config.toml to include paths you&rsquo;d like to exclude from being rendered.
+1 2 3 4 5 6 ... ignoreFiles = [ &#34;/content/templates/*&#34;, &#34;/content/private/*&#34;, &#34;&lt;your path here&gt;&#34; ] ignoreFiles supports the use of Regular Expressions (RegEx) so you can ignore patterns as well (e.g. ignoring all .pngs by doing \\.png$).
+More details in Hugo&rsquo;s documentation .
+Global Ignore However, just adding to the ignoreFiles will only prevent the page from being access through Quartz.Obsidian Vault Integrationhttps://quartz.jzhao.xyz/notes/obsidian/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/obsidian/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&rsquo;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.Setuphttps://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!
+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.Preview Changeshttps://quartz.jzhao.xyz/notes/preview-changes/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/preview-changes/If you&rsquo;d like to preview what your Quartz site looks like before deploying it to the internet, here&rsquo;s exactly how to do that!
+Install hugo-obsidian This step will generate the list of backlinks for Hugo to parse. Ensure you have Go (&gt;= 1.16) installed.
+1 2 3 4 5 6 7 8 # Install and link `hugo-obsidian` locally $ go install github.com/jackyzha0/hugo-obsidian # Navigate to your local Quartz folder $ cd &lt;location-of-your-local-quartz&gt; # 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!Setuphttps://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/Common Pitfalls Do I need a website already? No! Setting up Quartz means you set up a site too :)
-command not found: hugo-obsidian Make sure you set your GOPATH correctly! This will allow your terminal to correctly recognize hugo-obsidian as an executable.
-1 2 3 4 5 6 # Add the following 2 lines to your ~/.bash_profile export GOPATH=/Users/$USER/go export PATH=$GOPATH/bin:$PATH # In your current terminal, to reload the session source ~/.
\ No newline at end of file
+📁 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/Common Pitfalls Can I publish only a subset of my pages? Yes! Quartz makes selective publishing really easy. Heres a guide on excluding pages from being published .
+Can I host this myself and not on GitHub Pages? Yes! All built files can be found under /public in the master branch. More details under hosting .
+Do I need a website already? No! Setting up Quartz means you set up a site too :)
\ No newline at end of file
diff --git a/notes/obsidian/index.html b/notes/obsidian/index.html
index 18e847fbf..ab2148683 100644
--- a/notes/obsidian/index.html
+++ b/notes/obsidian/index.html
@@ -1,7 +1,7 @@
-Obsidian Vault Integration

+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.
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 SettingsObsidian 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!
Backlinks
Interactive Graph
Made by Jacky Zhao using Quartz, © 2021
Home
+.
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 SettingsObsidian 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!
Backlinks
Interactive Graph

\ No newline at end of file
diff --git a/notes/preview-changes/index.html b/notes/preview-changes/index.html
new file mode 100644
index 000000000..522231bcc
--- /dev/null
+++ b/notes/preview-changes/index.html
@@ -0,0 +1,37 @@
+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
+Go
+(>= 1.16) installed.
1
+2
+3
+4
+5
+6
+7
+8
+
# Install and link `hugo-obsidian` locally
+$ go install github.com/jackyzha0/hugo-obsidian
+
+# 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!
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/
+
Backlinks
Interactive Graph

\ No newline at end of file
diff --git a/notes/setup/index.html b/notes/setup/index.html
index 6207349dd..b45e6cc6d 100644
--- a/notes/setup/index.html
+++ b/notes/setup/index.html
@@ -1,4 +1,4 @@
-Setup

+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:
📁
@@ -11,5 +11,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.

✏️ Editing Notes in Quartz

Having problems? Checkout our FAQ and Troubleshooting guide -.

Backlinks

Interactive Graph

Made by Jacky Zhao using Quartz, © 2021

Home +.

Backlinks

Interactive Graph

\ No newline at end of file diff --git a/notes/troubleshooting/index.html b/notes/troubleshooting/index.html index 99ef3b45c..f7369e233 100644 --- a/notes/troubleshooting/index.html +++ b/notes/troubleshooting/index.html @@ -1,5 +1,9 @@ -Troubleshooting and FAQ
-

Troubleshooting and FAQ

Common Pitfalls

Do I need a website already?

No! Setting up Quartz means you set up a site too :)

command not found: hugo-obsidian

Make sure you set your GOPATH correctly! This will allow your terminal to correctly recognize hugo-obsidian as an executable.

1
+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
+excluding pages from being published
+.
Can I host this myself and not on GitHub Pages?
Yes! All built files can be found under /public in the master branch. More details under
+hosting
+.
Do I need a website already?
No! Setting up Quartz means you set up a site too :)
command not found: hugo-obsidian
Make sure you set your GOPATH correctly! This will allow your terminal to correctly recognize hugo-obsidian as an executable.
1
 2
 3
 4
@@ -27,5 +31,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.
🐛
-Submit an Issue
Backlinks
Interactive Graph
Made by Jacky Zhao using Quartz, © 2021
Home
+Submit an Issue
Backlinks
Interactive Graph

\ No newline at end of file
diff --git a/sitemap.xml b/sitemap.xml
index 4c4a65dca..81dc2091a 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/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/moc/showcase/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/notes/external-hosting/https://quartz.jzhao.xyz/notes/ignore-notes/https://quartz.jzhao.xyz/moc/https://quartz.jzhao.xyz/notes/https://quartz.jzhao.xyz/notes/obsidian/https://quartz.jzhao.xyz/notes/preview-changes/https://quartz.jzhao.xyz/moc/directory/https://quartz.jzhao.xyz/notes/setup/https://quartz.jzhao.xyz/moc/showcase/https://quartz.jzhao.xyz/tags/https://quartz.jzhao.xyz/notes/troubleshooting/
\ No newline at end of file