docs: make incompability of trailing slashes clear

iyue · Aug 23, 2023 · 960c181 · 960c181
1 parent eed4472
commit 960c181
Showing 1 changed file with 3 additions and 0 deletions.
diff --git 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"