From 41642e23dfb4d0ba265d6895f6eeb548aaa71fd3 Mon Sep 17 00:00:00 2001 From: Jacky Zhao Date: Wed, 23 Aug 2023 12:23:49 -0700 Subject: [PATCH] docs: make incompability of trailing slashes clear --- docs/hosting.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/hosting.md b/docs/hosting.md index d6ccd0bd..d648f558 100644 --- a/docs/hosting.md +++ b/docs/hosting.md @@ -30,6 +30,9 @@ To add a custom domain, check out [Cloudflare's documentation](https://developer Like Quartz 3, you can deploy the site generated by Quartz 4 via GitHub Pages. +> [!warning] +> Quartz generates files in the format of `file.html` instead of `file/index.html` which means the trailing slashes for _non-folder paths_ are dropped. As GitHub pages does not do this redirect, this may cause existing links to your site that use trailing slashes to break. If not breaking existing links is important to you, consider using [[#Cloudflare Pages]]. + In your local Quartz, create a new file `quartz/.github/workflows/deploy.yml`. ```yaml title="quartz/.github/workflows/deploy.yml"