From 69c86e407fa14ea94c75de82ca55ec9efaf6fb37 Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Thu, 23 Dec 2021 22:21:39 +0000
Subject: [PATCH] update subdomain docs
---
content/notes/hosting.md | 12 +++++++++---
assets/base.scss | 2 +-
2 files changed, 10 insertions(+), 4 deletions(-)
diff --git a/assets/base.scss b/assets/base.scss
index f50e9cc..982dc07 100644
--- a/assets/base.scss
+++ b/assets/base.scss
@@ -233,7 +233,7 @@
& #graph-container {
border: var(--outlinegray) 1px solid;
- border-radius: 5px
+ border-radius: 5px;
}
}
diff --git a/content/notes/hosting.md b/content/notes/hosting.md
index c6027bb..703fdfd 100644
--- a/content/notes/hosting.md
+++ b/content/notes/hosting.md
@@ -39,15 +39,21 @@
Here, we take advantage of GitHub's free page hosting to deploy our site. Change `baseURL` in `/config.toml`. If you don't have a custom domain to use, you can use `<YOUR-USERNAME>.github.io` (which GitHub gives to you for free!) as your domain.
-[Reference.](https://github.com/jackyzha0/quartz/blob/hugo/config.toml)
+[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.
+
+```toml
+baseURL = "https://<YOUR-GITHUB-USERNAME>.github.io/quartz/"
+```
+
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`.
-[Reference.](https://github.com/jackyzha0/quartz/blob/hugo/.github/workflows/deploy.yaml)
+[Reference `deploy.yaml` here](https://github.com/jackyzha0/quartz/blob/hugo/.github/workflows/deploy.yaml)
```yaml
- name: Deploy
@@ -82,4 +88,4 @@
🎨 [Customizing Quartz](notes/config.md)
-Having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).
\ No newline at end of file
+Having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).
--
Gitblit v1.10.0