From 6a658f5f041092beb604217c827cab347e5e81d8 Mon Sep 17 00:00:00 2001 From: jackyzha0 Date: Fri, 13 Aug 2021 03:49:37 +0000 Subject: [PATCH] deploy: 8850976d8dbb9a67d0224ed1ea30bd90fdbf4faa --- index.html | 2 +- index.xml | 2 +- moc/directory/index.html | 2 +- moc/index.xml | 2 +- moc/showcase/index.html | 4 ++-- notes/config/index.html | 2 +- notes/editing/index.html | 2 +- notes/external-hosting/index.html | 2 +- notes/hosting/index.html | 2 +- notes/ignore-notes/index.html | 2 +- notes/obsidian/index.html | 2 +- notes/preview-changes/index.html | 2 +- notes/setup/index.html | 2 +- notes/troubleshooting/index.html | 2 +- 14 files changed, 15 insertions(+), 15 deletions(-) diff --git a/index.html b/index.html index 9dd27c539..d97524147 100644 --- a/index.html +++ b/index.html @@ -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


Interactive Graph

\ No newline at end of file +Directory


Interactive Graph

\ No newline at end of file diff --git a/index.xml b/index.xml index 4396f6a35..82936d632 100644 --- a/index.xml +++ b/index.xml @@ -18,6 +18,6 @@ Let’s get to business and get you started! 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 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 . +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 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 8dcb28809..fd4b20223 100644 --- a/moc/directory/index.html +++ b/moc/directory/index.html @@ -7,5 +7,5 @@ community digital gardens built with Quartz!

Troubleshooting


Interactive Graph

Made by Jacky Zhao using Quartz, © 2021

Home +Submit an Issue

Interactive Graph

\ No newline at end of file diff --git a/moc/index.xml b/moc/index.xml index 2ab0f905f..c17d70c6b 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’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! 📚 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!) Strengthening Online Social Bonds: Research Garden Jacky Zhao’s Garden Anson Yu’s Garden Shihyu’s PKM Chloe’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!) Strengthening Online Social Bonds: Research Garden Jacky Zhao’s Garden Anson Yu’s Garden Shihyu’s PKM Chloe’s Garden SlRvb’s Site 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 69845a726..cbc482581 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 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 19457aa94..9213dd199 100644 --- a/notes/config/index.html +++ b/notes/config/index.html @@ -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 -.


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 4214c101c..ae155c70d 100644 --- a/notes/editing/index.html +++ b/notes/editing/index.html @@ -25,5 +25,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/external-hosting/index.html b/notes/external-hosting/index.html index 009d98cfa..6e27a0142 100644 --- a/notes/external-hosting/index.html +++ b/notes/external-hosting/index.html @@ -1,3 +1,3 @@ External Hosting
-

External Hosting


Interactive Graph

Made by Jacky Zhao using Quartz, © 2021

Home +

External Hosting


Interactive Graph

\ No newline at end of file diff --git a/notes/hosting/index.html b/notes/hosting/index.html index c3d7916a2..c0cb73557 100644 --- a/notes/hosting/index.html +++ b/notes/hosting/index.html @@ -38,5 +38,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 Quarts

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 24aa2356d..e240bd7c9 100644 --- a/notes/ignore-notes/index.html +++ b/notes/ignore-notes/index.html @@ -13,5 +13,5 @@ ]

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.


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/obsidian/index.html b/notes/obsidian/index.html index 84171f1bd..7dc000611 100644 --- a/notes/obsidian/index.html +++ b/notes/obsidian/index.html @@ -3,5 +3,5 @@ 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 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

\ No newline at end of file diff --git a/notes/preview-changes/index.html b/notes/preview-changes/index.html index 9e5e5d139..5e97a1b01 100644 --- a/notes/preview-changes/index.html +++ b/notes/preview-changes/index.html @@ -33,5 +33,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 89fa01e52..392631a26 100644 --- a/notes/setup/index.html +++ b/notes/setup/index.html @@ -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 -.


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 3c4fa074a..402812e9d 100644 --- a/notes/troubleshooting/index.html +++ b/notes/troubleshooting/index.html @@ -31,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


Interactive Graph

Made by Jacky Zhao using Quartz, © 2021

Home +Submit an Issue


Interactive Graph

\ No newline at end of file