From dd11d56dd986c82914ce529fb43c8e2beb78a094 Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Fri, 23 Sep 2022 17:17:34 +0000
Subject: [PATCH] Merge branch 'hugo' of https://github.com/jackyzha0/quartz into hugo
---
content/notes/hosting.md | 18 +++++++++++++-----
1 files changed, 13 insertions(+), 5 deletions(-)
diff --git a/content/notes/hosting.md b/content/notes/hosting.md
index bb1d912..fffcd65 100644
--- a/content/notes/hosting.md
+++ b/content/notes/hosting.md
@@ -2,9 +2,12 @@
title: "Deploying Quartz to the Web"
tags:
- setup
+weight: -1
+aliases:
+- hosting
---
-## GitHub Pages
+## Hosting on 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! Follow the steps below.
### Enable GitHub Actions
@@ -41,7 +44,7 @@
### Setting up the Site
Now let's get this site up and running. Never hosted a site before? No problem. Have a fancy custom domain you already own or want to subdomain your Quartz? That's easy too.
-Here, we take advantage of GitHub's free page hosting to deploy our site. Change `baseURL` in `/config.toml`.
+Here, we take advantage of GitHub's free page hosting to deploy our site. Change `baseURL` in `/config.toml`.
Make sure that your `baseURL` has a trailing `/`!
@@ -51,7 +54,7 @@
baseURL = "https://<YOUR-DOMAIN>/"
```
-If you are using this under a subdomain (e.g. `<YOUR-GITHUB-USERNAME>.github.io/quartz`), include the trailing `/`.
+If you are using this under a subdomain (e.g. `<YOUR-GITHUB-USERNAME>.github.io/quartz`), include the trailing `/`. **You need to do this especially if you are using GitHub!**
```toml
baseURL = "https://<YOUR-GITHUB-USERNAME>.github.io/quartz/"
@@ -63,7 +66,7 @@
[Reference `deploy.yaml` here](https://github.com/jackyzha0/quartz/blob/hugo/.github/workflows/deploy.yaml)
-```yaml
+```yaml {title=".github/workflows/deploy.yaml"}
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
@@ -75,10 +78,15 @@
Have a custom domain? [Learn how to set it up with Quartz ](notes/custom%20Domain.md).
+### 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](notes/ignore%20notes.md)
+
---
Now that your Quartz is live, let's figure out how to make Quartz really *yours*!
-🎨 [Customizing Quartz](notes/config.md)
+> Step 6: 🎨 [Customizing Quartz](notes/config.md)
Having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).
--
Gitblit v1.10.0