nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2025-03-20 16:15:09 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: clarify serving use cases

Browse source
This commit is contained in:
Sören Weber 2024-02-24 15:39:25 +01:00
parent 6d900dd79a
commit 1427f1053f
No known key found for this signature in database
GPG key ID: BEC6D55545451B6D
1 changed files with 6 additions and 1 deletions

7
exampleSite/content/basics/customization/_index.en.md
View file

@ -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.