From 8a100edeb81382dc838f600ee1b8dbd3e7560e37 Mon Sep 17 00:00:00 2001 From: Jacky Zhao <j.zhao2k19@gmail.com> Date: Wed, 29 Jun 2022 23:57:36 +0000 Subject: [PATCH] docs: polish and update --- content/notes/hosting.md | 20 +++++++++++++++----- 1 files changed, 15 insertions(+), 5 deletions(-) diff --git a/content/notes/hosting.md b/content/notes/hosting.md index a6725b7..adda82d 100644 --- a/content/notes/hosting.md +++ b/content/notes/hosting.md @@ -2,6 +2,7 @@ title: "Deploying Quartz to the Web" tags: - setup +weight: 4 --- ## GitHub Pages @@ -16,13 +17,13 @@ Head to the 'Settings' tab of your forked repository and go to the 'Pages' tab. -1. (IMPORTANT) Set the source to deploy from `master` using `/ (root)` +1. (IMPORTANT) Set the source to deploy from `master` (and not `hugo`) using `/ (root)` 2. Set a custom domain here if you have one! *Enable 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. +To see your changes on the internet, we need to push it them to GitHub. Quartz is a `git` repository so updating it is the same workflow as you would follow as if it were just a regular software project. ```shell # Navigate to Quartz folder @@ -41,7 +42,9 @@ ### 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 `/`! [Reference `config.toml` here](https://github.com/jackyzha0/quartz/blob/hugo/config.toml) @@ -49,7 +52,7 @@ baseURL = "https://<YOUR-DOMAIN>/" ``` -If you are using this under a subdomain (e.g. `<YOUR-GITHUB-USERNAME>.github.io/quartz`), include the trailing path. +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/" @@ -57,6 +60,8 @@ Change `cname` in `/.github/workflows/deploy.yaml`. Again, if you don't have a custom domain to use, you can use `<YOUR-USERNAME>.github.io`. +Please note that the `cname` field should *not* have any path `e.g. end with /quartz` or have a trailing `/`. + [Reference `deploy.yaml` here](https://github.com/jackyzha0/quartz/blob/hugo/.github/workflows/deploy.yaml) ```yaml @@ -71,10 +76,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