From c17d18f2cef78258465a232637711dc9c38dd7e8 Mon Sep 17 00:00:00 2001 From: jackyzha0 Date: Mon, 27 Dec 2021 22:54:24 +0000 Subject: [PATCH] deploy: a45856d7884fedd3a3bd6b80489c206c75427112 --- 404.html | 2 +- index.html | 10 +++++----- index.xml | 27 ++++++++------------------- moc/index.html | 9 +++++++++ moc/showcase/index.html | 6 +++--- notes/config/index.html | 8 +++++--- notes/editing/index.html | 6 +++--- notes/hosting/index.html | 6 +++--- notes/ignore-notes/index.html | 6 +++--- notes/index.html | 15 +++++++++++++++ notes/index.xml | 25 +++++++------------------ notes/obsidian/index.html | 6 +++--- notes/philosophy/index.html | 6 +++--- notes/preview-changes/index.html | 6 +++--- notes/setup/index.html | 6 +++--- notes/troubleshooting/index.html | 16 +++++++++++++--- sitemap.xml | 2 +- tags/setup/index.xml | 16 ++++------------ 18 files changed, 92 insertions(+), 86 deletions(-) create mode 100644 moc/index.html create mode 100644 notes/index.html diff --git a/404.html b/404.html index f91839bd0..5ed04133a 100644 --- a/404.html +++ b/404.html @@ -1,2 +1,2 @@ -404 Page not found
+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 4dbbc576a..5f1be4b5b 100644 --- a/index.html +++ b/index.html @@ -1,16 +1,16 @@ -🪓 Quartz 3

🪓 Quartz 3

Search IconIcon to open search
-

Host your second brain and digital garden -for free. Quartz features

  1. Extremely fast full-text search by pressing /
  2. Beautiful, out-of-the-box website creation and deployment
  3. Display for backlinks of each note
  4. A customizable graph view
  5. Endlessly powerful page and theme customization

Get Started

šŸ“š +for free. Quartz features

  1. Extremely fast full-text search by pressing /
  2. Beautiful, out-of-the-box website creation and deployment
  3. Display for backlinks of each note
  4. A customizable graph view
  5. Endlessly powerful page and theme customization
  6. Automatically generated tag and section lists of content

Get Started

šŸ“š Setup your own digital garden using Quartz

Not convinced yet? Look at some community digital gardens built with Quartz, or read about why I made Quartz -to begin with!

Troubleshooting


Interactive Graph

\ No newline at end of file +Submit an Issue

Interactive Graph

\ No newline at end of file diff --git a/index.xml b/index.xml index a0c5021ad..17d1d1052 100644 --- a/index.xml +++ b/index.xml @@ -1,20 +1,9 @@ 🪓 Quartz 3 onhttps://quartz.jzhao.xyz/Recent content in 🪓 Quartz 3 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’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 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 <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 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](notes/Obsidian.md) -Of course, all the files are in Markdown so you could just use your favourite text editor of choice.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’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$). To ignore a specific file, you can also add the tag draft: true to the frontmatter of a note.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’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.Preview Changeshttps://quartz.jzhao.xyz/notes/preview-changes/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/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 -index=true Afterwards, start the Hugo server as shown above and your local backlinks and interactive graph should be populated!Quartz Philosophyhttps://quartz.jzhao.xyz/notes/philosophy/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/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 Notion , Roam , and Obsidian , yet none of them have super easy to use free tools to publish that garden to the world.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!) 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 !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 +The majority of configuration can be be found under data/config.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 <YOUR-GITHUB-USERNAME.github.io/quartz to see it live.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 . +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.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’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.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’t have an existing Vault, download Obsidian and create a new Vault in the /content folder that you created and cloned during the setup .Preview Changeshttps://quartz.jzhao.xyz/notes/preview-changes/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/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.Quartz Philosophyhttps://quartz.jzhao.xyz/notes/philosophy/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/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?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.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!) 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 !Troubleshooting and FAQhttps://quartz.jzhao.xyz/notes/troubleshooting/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/troubleshooting/Common Pitfalls 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. \ No newline at end of file diff --git a/moc/index.html b/moc/index.html new file mode 100644 index 000000000..fc290a1f7 --- /dev/null +++ b/moc/index.html @@ -0,0 +1,9 @@ +Mocs

🪓 Quartz v3

Search IconIcon to open search
+

All Mocs

  • Showcase

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

    1 minute read. Last updated December 27, 2021

\ No newline at end of file diff --git a/moc/showcase/index.html b/moc/showcase/index.html index 2165c7c50..c3beb3a1e 100644 --- a/moc/showcase/index.html +++ b/moc/showcase/index.html @@ -1,10 +1,10 @@ -Showcase

🪓 Quartz v3

Search IconIcon to open search
-

Showcase

Last updated December 27, 2021

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


Interactive Graph

Made by Jacky Zhao using Quartz, Ā© 2021

Home +!


Interactive Graph

\ No newline at end of file diff --git a/notes/config/index.html b/notes/config/index.html index 612b003fb..d8f146c3e 100644 --- a/notes/config/index.html +++ b/notes/config/index.html @@ -1,10 +1,10 @@ -Configuration

🪓 Quartz v3

Search IconIcon to open search
-

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
+

Configuration

Last updated December 27, 2021

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
@@ -29,13 +29,15 @@
 3
 4
 5
+6
 
enableLegend: false # automatically generate a legend
 enableDrag: true # allow dragging nodes in the graph
 enableZoom: true # allow zooming and panning the graph
+depth: -1 # how many neighbours of the current node to show (-1 is all nodes)
 paths: # colour specific nodes path off of their path
   - /moc: "#4388cc"
 

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


Interactive Graph

Made by Jacky Zhao using Quartz, Ā© 2021

Home +.


Interactive Graph

\ No newline at end of file diff --git a/notes/editing/index.html b/notes/editing/index.html index a450f6469..3ca3ddba2 100644 --- a/notes/editing/index.html +++ b/notes/editing/index.html @@ -1,10 +1,10 @@ -Editing Content in Quartz

🪓 Quartz v3

Search IconIcon to open search
-

Editing Content in Quartz

Last updated December 27, 2021

Editing

Quartz runs on top of Hugo so all notes are written in Markdown @@ -29,5 +29,5 @@ Rest of your content here... 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 -.


Interactive Graph

Made by Jacky Zhao using Quartz, Ā© 2021

Home +.


Interactive Graph

\ No newline at end of file diff --git a/notes/hosting/index.html b/notes/hosting/index.html index 56740584f..1f746c9fe 100644 --- a/notes/hosting/index.html +++ b/notes/hosting/index.html @@ -1,10 +1,10 @@ -Deploying Quartz to the Web

🪓 Quartz v3

Search IconIcon to open search
-

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
+

Deploying Quartz to the Web

Last updated December 27, 2021

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
@@ -45,5 +45,5 @@ git push origin hugo
 , 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 Quartz

Having problems? Checkout our FAQ and Troubleshooting guide -.


Interactive Graph

Made by Jacky Zhao using Quartz, Ā© 2021

Home +.


Interactive Graph

\ No newline at end of file diff --git a/notes/ignore-notes/index.html b/notes/ignore-notes/index.html index 175f93e22..1c743f6c0 100644 --- a/notes/ignore-notes/index.html +++ b/notes/ignore-notes/index.html @@ -1,10 +1,10 @@ -Ignoring Notes

🪓 Quartz v3

Search IconIcon to open search
-

Ignoring Notes

Quartz Ignore

Edit ignoreFiles in config.toml to include paths you’d like to exclude from being rendered.

1
+

Ignoring Notes

Last updated December 27, 2021

Quartz Ignore

Edit ignoreFiles in config.toml to include paths you’d like to exclude from being rendered.

1
 2
 3
 4
@@ -29,5 +29,5 @@ draft: true
 ...
 

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.


Interactive Graph

Made by Jacky Zhao using Quartz, Ā© 2021

Home +.

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.


Interactive Graph

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

🪓 Quartz v3

Search IconIcon to open search
+

All Notes

  • Troubleshooting and FAQ

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

    3 minute read. Last updated December 27, 2021

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

    1 minute read. Last updated December 27, 2021

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

    1 minute read. Last updated December 27, 2021

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

    1 minute read. Last updated December 27, 2021

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

    2 minute read. Last updated December 27, 2021

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

    1 minute read. Last updated December 27, 2021

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

    2 minute read. Last updated December 27, 2021

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

    3 minute read. Last updated December 27, 2021

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

    2 minute read. Last updated December 27, 2021

\ No newline at end of file diff --git a/notes/index.xml b/notes/index.xml index 9e4bfd6c2..b99a63f1e 100644 --- a/notes/index.xml +++ b/notes/index.xml @@ -1,19 +1,8 @@ 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 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](notes/Obsidian.md) -Of course, all the files are in Markdown so you could just use your favourite text editor of choice.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$). To ignore a specific file, you can also add the tag draft: true to the frontmatter of a note.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.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 -index=true Afterwards, start the Hugo server as shown above and your local backlinks and interactive graph should be populated!Quartz Philosophyhttps://quartz.jzhao.xyz/notes/philosophy/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/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&rsquo;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.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 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 +The majority of configuration can be be found under data/config.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.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 . +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.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.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 .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.Quartz Philosophyhttps://quartz.jzhao.xyz/notes/philosophy/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/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?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.Troubleshooting and FAQhttps://quartz.jzhao.xyz/notes/troubleshooting/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/troubleshooting/Common Pitfalls Some of my pages have &lsquo;January 1, 0001&rsquo; 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. \ No newline at end of file diff --git a/notes/obsidian/index.html b/notes/obsidian/index.html index 6d9b7ccbf..f7342bfb0 100644 --- a/notes/obsidian/index.html +++ b/notes/obsidian/index.html @@ -1,12 +1,12 @@ -Obsidian Vault Integration

🪓 Quartz v3

Search IconIcon to open search
-

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, +

Obsidian Vault Integration

Last updated December 27, 2021

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!


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


Interactive Graph

\ No newline at end of file diff --git a/notes/philosophy/index.html b/notes/philosophy/index.html index 7b2f8d46b..2fa1bc4ab 100644 --- a/notes/philosophy/index.html +++ b/notes/philosophy/index.html @@ -1,10 +1,10 @@ -Quartz Philosophy

🪓 Quartz v3

Search IconIcon to open search
-

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 December 27, 2021

ā€œ[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.


Interactive Graph

Made by Jacky Zhao using Quartz, Ā© 2021

Home +’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.


Interactive Graph

\ No newline at end of file diff --git a/notes/preview-changes/index.html b/notes/preview-changes/index.html index 085e42aa1..84a8a4fb3 100644 --- a/notes/preview-changes/index.html +++ b/notes/preview-changes/index.html @@ -1,10 +1,10 @@ -Preview Changes

🪓 Quartz v3

Search IconIcon to open search
-

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 +

Preview Changes

Last updated December 27, 2021

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
@@ -38,5 +38,5 @@ $ cd <location-of-your-local-quartz>
 $ hugo server
 
 # View your site in a browser at http://localhost:1313/
-

Interactive Graph


Interactive Graph

\ No newline at end of file diff --git a/notes/setup/index.html b/notes/setup/index.html index eaf9d2165..e02a46970 100644 --- a/notes/setup/index.html +++ b/notes/setup/index.html @@ -1,10 +1,10 @@ -Setup

🪓 Quartz v3

Search IconIcon to open search
-

Setup

Last updated December 27, 2021

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

āœļø Editing Notes in Quartz

Having problems? Checkout our FAQ and Troubleshooting guide -.


Interactive Graph

Made by Jacky Zhao using Quartz, Ā© 2021

Home +.


Interactive Graph

\ No newline at end of file diff --git a/notes/troubleshooting/index.html b/notes/troubleshooting/index.html index 98878c0c0..eca79bc08 100644 --- a/notes/troubleshooting/index.html +++ b/notes/troubleshooting/index.html @@ -1,10 +1,20 @@ -Troubleshooting and FAQ

Troubleshooting and FAQ

Last updated December 27, 2021

Common Pitfalls

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
+4
+5
+
# in the root of your Quartz (same folder as config.toml)
+git config core.ignorecase true
+
+# or globally (not recommended)
+git config --global core.ignorecase true
+

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 @@ -36,5 +46,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


Interactive Graph

Made by Jacky Zhao using Quartz, Ā© 2021

Home +Submit an Issue


Interactive Graph

\ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml index 4fe1a3c2a..2d2bdf425 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -1 +1 @@ -https://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/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/notes/philosophy/https://quartz.jzhao.xyz/notes/setup/https://quartz.jzhao.xyz/tags/setup/https://quartz.jzhao.xyz/moc/showcase/https://quartz.jzhao.xyz/tags/https://quartz.jzhao.xyz/notes/troubleshooting/https://quartz.jzhao.xyz/ \ No newline at end of file +https://quartz.jzhao.xyz/categories/https://quartz.jzhao.xyz/notes/config/2021-12-27T17:53:33-05:00https://quartz.jzhao.xyz/notes/hosting/2021-12-27T17:53:33-05:00https://quartz.jzhao.xyz/notes/editing/2021-12-27T17:53:33-05:00https://quartz.jzhao.xyz/notes/ignore-notes/2021-12-27T17:53:33-05:00https://quartz.jzhao.xyz/moc/2021-12-27T17:53:33-05:00https://quartz.jzhao.xyz/notes/2021-12-27T17:53:33-05:00https://quartz.jzhao.xyz/notes/obsidian/2021-12-27T17:53:33-05:00https://quartz.jzhao.xyz/notes/preview-changes/2021-12-27T17:53:33-05:00https://quartz.jzhao.xyz/notes/philosophy/2021-12-27T17:53:33-05:00https://quartz.jzhao.xyz/notes/setup/2021-12-27T17:53:33-05:00https://quartz.jzhao.xyz/tags/setup/2021-12-27T17:53:33-05:00https://quartz.jzhao.xyz/moc/showcase/2021-12-27T17:53:33-05:00https://quartz.jzhao.xyz/tags/2021-12-27T17:53:33-05:00https://quartz.jzhao.xyz/notes/troubleshooting/2021-12-27T17:53:33-05:00https://quartz.jzhao.xyz/2021-12-27T17:53:33-05:00 \ No newline at end of file diff --git a/tags/setup/index.xml b/tags/setup/index.xml index dbb46f7f1..c35b429e6 100644 --- a/tags/setup/index.xml +++ b/tags/setup/index.xml @@ -1,13 +1,5 @@ setup onhttps://quartz.jzhao.xyz/tags/setup/Recent content in setup 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 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](notes/Obsidian.md) -Of course, all the files are in Markdown so you could just use your favourite text editor of choice.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! -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. \ No newline at end of file +The majority of configuration can be be found under data/config.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.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 . +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.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 .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. \ No newline at end of file