From 1427f1053f553d72446d8805a87f4f5741564f73 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6ren=20Weber?= <mail@soeren-weber.de> Date: Sat, 24 Feb 2024 15:39:25 +0100 Subject: [PATCH] docs: clarify serving use cases --- exampleSite/content/basics/customization/_index.en.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/exampleSite/content/basics/customization/_index.en.md b/exampleSite/content/basics/customization/_index.en.md index 46ae5f2b04..94cefb8dd6 100644 --- a/exampleSite/content/basics/customization/_index.en.md +++ b/exampleSite/content/basics/customization/_index.en.md @@ -11,7 +11,6 @@ If your site is served from a subfolder, eg. `https://example.com/mysite/`, you baseURL = "https://example.com/mysite/" ```` - ## Serving your page from the filesystem If you want your page served from the filesystem by using URLs starting with `file://` you'll need the following configuration in your `hugo.toml`: @@ -35,6 +34,12 @@ Sublemental pages (like `sitemap.xml`, `rss.xml`) will always be generated with If you want to use the search feature from the file system, migrating from an older installation of the theme, make sure to change your outputformat for the homepage from the now deprecated `json` to `search` [as seen below](#activate-search). {{% /notice %}} +{{% notice warning %}} +[Serving your page from a subfolder](#serving-your-page-from-a-subfolder) and [Serving your page from the filesystem](#serving-your-page-from-the-filesystem) are mutally exclusive due to the fact, that [Hugo does not apply the `baseURL` correctly](https://github.com/gohugoio/hugo/issues/12130). + +If you need both, you have to generate your site twice but with different settings into separate directories. +{{% /notice %}} + ## Activate search If not already present, add the following lines in your `hugo.toml` file.