Allow for subdirs in site address

rootwork commented 2 years ago

This PR...

Changes / fixes

Changes:

Replaces parentURL and rootURL variables in JS with baseURL derived from Hugo config (in a config file or at the command line with --baseURL)
Changes the URL construction of the calls to index.json coming from search. I'm not sure why this was failing when changing the rootURL/baseURL value before, but simply concatenating the values seems to work.
Replaces a hardcoded call to images with the configurable image directory in the image-related layout partials.
Updates the example site's posts to ensure images load even in a site within a subdir (and they still load fine in a site at a root domain).

Adds:

Provides configurable imagesDir, fontsDir and iconsDir variables and normalizes the names.
Passes those values, plus baseURL, to Sass as variables. Hugo's "ExecuteAsTemplate" option only works on the primary Sass file, not partials (ref here and here), so these are defined in main.sass. This means these variables are also available to end-users in their _override.s{a|c}ss and _custom.s{a|c}ss files!
Uses the Sass variables in the partials to define paths to fonts and images, including the subheader-permalink icon, which is moved from JS to Sass to make it easier to override for end-users. (Otherwise they'd have to override the entire JS function just to change the image.)

Try using the theme with a site address containing a subdirectory (e.g. hugo server --baseURL http://localhost:1313/foo/)
Try using the theme with a site address at a root domain (e.g. hugo server)

In each, check:

The ability to perform searches
The presence of the light/dark mode switch icons
The presence of the correct custom fonts
On the "Markdown Syntax Guide" post, ensure that
- all images load
- the permalink icon (chain link) appears when hovering over subheadings
- the icons appear in the code block when hovering (copy, number, etc.)
Optionally open a web debug console and see if any file references are returning 404s

Ensure you have checked off the following before submitting your PR.

[x] tested locally with the latest release of Hugo. This requirement is a standard
[x] added new dependencies (n/a)
[x] updated the [docs]() ⚠️

dennys commented 2 years ago

Hi, I have an issue and it's fixed by this patch. You can reference here, thanks. https://github.com/chipzoller/hugo-clarity/discussions/325

chipzoller commented 2 years ago

@onweru are you good with this?