Global site parameters
On top of Hugo global configuration, the Relearn theme lets you define the following parameters in your
config.toml (here, values are default).
Note that some of these parameters are explained in details in other sections of this documentation.
A word on running your site in a subfolder
The theme runs best if your site is installed in the root of your webserver. If your site is served from a subfolder, eg.
https://example.com/mysite/, you have to set the following lines to your
baseURL = "https://example.com/mysite/" canonifyURLs = true
canonifyURLs=true URLs in sublemental pages (like
rss.xml) will be generated falsly while your HTML files will still work. See https://github.com/gohugoio/hugo/issues/5226.
If not already present, add the follow lines in the same
[outputs] home = [ "HTML", "RSS", "JSON"]
Hugo generate lunrjs index.json at the root of public folder. When you build the site with
hugo server, hugo generates it internally and of course it doesn’t show up in the filesystem
The Mermaid configuration parameters can also be set on a specific page. In this case, the global parameter would be overwritten by the local one. See Mermaid for additional documentation.
Mermaid is globally disabled. By default it won’t be loaded by any page. On page “Architecture” you need a class diagram. You can set the Mermaid parameters locally to only load mermaid on this page (not on the others).
You also can disable Mermaid for specific pages while globally enabled.
Home Button Configuration
disableLandingPageButton option is set to
false, a Home button will appear
on the left menu. It is an alternative for clicking on the logo. To edit the
appearance, you will have to configure two parameters for the defined languages:
[Languages] [Languages.en] ... landingPageURL = "/" landingPageName = "<i class='fas fa-home'></i> Home" ... [Languages.pir] ... landingPageURL = "/pir/" landingPageName = "<i class='fas fa-home'></i> Arrr! Homme" ...
If those params are not configured for a specific language, they will get their default values:
landingPageURL = "/" landingPageName = "<i class='fas fa-home'></i> Home"
The home button is going to look like this: