From 896f231a280951be063417453a205d8f75db4d36 Mon Sep 17 00:00:00 2001 From: jackyzha0 Date: Fri, 13 Aug 2021 21:46:08 +0000 Subject: [PATCH] deploy: 27c33f8334f6ac4a67c2a12b8eed219e6d8aeb2b --- 404.html | 4 ++-- index.html | 4 ++-- moc/directory/index.html | 6 +++--- moc/showcase/index.html | 6 +++--- notes/config/index.html | 6 +++--- notes/editing/index.html | 6 +++--- notes/external-hosting/index.html | 6 +++--- notes/hosting/index.html | 6 +++--- notes/ignore-notes/index.html | 6 +++--- notes/obsidian/index.html | 6 +++--- notes/preview-changes/index.html | 6 +++--- notes/setup/index.html | 6 +++--- notes/troubleshooting/index.html | 6 +++--- 13 files changed, 37 insertions(+), 37 deletions(-) diff --git a/404.html b/404.html index 0402740f4..aa8e27b1a 100644 --- a/404.html +++ b/404.html @@ -1,2 +1,2 @@ -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 +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 d97524147..0b3094b33 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,4 @@ -Quartz Example Page
+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 @@ -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/moc/directory/index.html b/moc/directory/index.html index fd4b20223..f217fc8a4 100644 --- a/moc/directory/index.html +++ b/moc/directory/index.html @@ -1,4 +1,4 @@ -Quartz Documentation
+Quartz Documentation

Backlinks

Interactive Graph

\ No newline at end of file +Submit an Issue

Backlinks

Interactive Graph

\ No newline at end of file diff --git a/moc/showcase/index.html b/moc/showcase/index.html index cbc482581..85745ad6e 100644 --- a/moc/showcase/index.html +++ b/moc/showcase/index.html @@ -1,5 +1,5 @@ -Showcase
+Showcase

Backlinks

Interactive Graph

\ No newline at end of file +!

Backlinks

Interactive Graph

\ No newline at end of file diff --git a/notes/config/index.html b/notes/config/index.html index 9213dd199..a5d77c9c0 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

\ No newline at end of file +.

Backlinks

Interactive Graph

\ No newline at end of file diff --git a/notes/editing/index.html b/notes/editing/index.html index ae155c70d..92f7965b1 100644 --- a/notes/editing/index.html +++ b/notes/editing/index.html @@ -1,4 +1,4 @@ -Editing Content in Quartz
+Editing Content in Quartz

Editing Content in Quartz

Editing

Quartz runs on top of Hugo so all notes are written in @@ -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 -.

Backlinks

Interactive Graph

\ No newline at end of file +.

Backlinks

Interactive Graph

\ No newline at end of file diff --git a/notes/external-hosting/index.html b/notes/external-hosting/index.html index 6e27a0142..edff4361d 100644 --- a/notes/external-hosting/index.html +++ b/notes/external-hosting/index.html @@ -1,3 +1,3 @@ -External Hosting
-

External Hosting

Backlinks

  • No backlinks found

Interactive Graph

\ No newline at end of file +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 c0cb73557..f028a5977 100644 --- a/notes/hosting/index.html +++ b/notes/hosting/index.html @@ -1,4 +1,4 @@ -Deploying Quartz to the Web
+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
@@ -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
-.
Backlinks
Interactive Graph

\ No newline at end of file
+.
Backlinks
Interactive Graph

\ No newline at end of file
diff --git a/notes/ignore-notes/index.html b/notes/ignore-notes/index.html
index e240bd7c9..25b4d8dfd 100644
--- a/notes/ignore-notes/index.html
+++ b/notes/ignore-notes/index.html
@@ -1,4 +1,4 @@
-Ignoring Notes

+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
@@ -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.
Backlinks
Interactive Graph

\ No newline at end of file
+.
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/obsidian/index.html b/notes/obsidian/index.html
index 7dc000611..97f4635c5 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

\ No newline at end of file
+.
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
index 5e97a1b01..5fdaff9e0 100644
--- a/notes/preview-changes/index.html
+++ b/notes/preview-changes/index.html
@@ -1,4 +1,4 @@
-Preview Changes

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

\ No newline at end of file
+

Backlinks

Interactive Graph

\ No newline at end of file diff --git a/notes/setup/index.html b/notes/setup/index.html index 392631a26..860af24d1 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

\ No newline at end of file +.

Backlinks

Interactive Graph

\ No newline at end of file diff --git a/notes/troubleshooting/index.html b/notes/troubleshooting/index.html index 402812e9d..6363aee23 100644 --- a/notes/troubleshooting/index.html +++ b/notes/troubleshooting/index.html @@ -1,4 +1,4 @@ -Troubleshooting and FAQ
+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 @@ -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

Backlinks

Interactive Graph

\ No newline at end of file +Submit an Issue

Backlinks

Interactive Graph

\ No newline at end of file