From 3583265f80afa081bf7a1fe996a9b3fe3c4e32e0 Mon Sep 17 00:00:00 2001 From: meleu <meleu@users.noreply.github.com> Date: Mon, 04 Apr 2022 20:30:23 +0000 Subject: [PATCH] docs: warn about possible lost of customization --- content/notes/hosting.md | 12 ++++++++---- 1 files changed, 8 insertions(+), 4 deletions(-) diff --git a/content/notes/hosting.md b/content/notes/hosting.md index 0227fde..bb1d912 100644 --- a/content/notes/hosting.md +++ b/content/notes/hosting.md @@ -10,19 +10,19 @@ ### 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 Actions* +*Enable GitHub Actions* ### Enable GitHub Pages 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 @@ -43,13 +43,15 @@ 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) ```toml 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 `/`. ```toml baseURL = "https://<YOUR-GITHUB-USERNAME>.github.io/quartz/" @@ -57,6 +59,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 -- Gitblit v1.10.0