mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2025-01-18 19:00:24 +00:00
theme: switch from config.toml to hugo.toml #741
This commit is contained in:
Sören Weber
parent
3e440e5228
commit
283c61a0fd
33 changed files with 129 additions and 129 deletions
|
|
@ -114,7 +114,7 @@ disableRandomIds = false
|
|||
additionalContentLanguage = [ "en" ]
|
||||
|
||||
# Additional code dependencies.
|
||||
# Default: See config.toml of the theme
|
||||
# Default: See hugo.toml of the theme
|
||||
# The theme provides a mechanism to load further JavaScript and CSS
|
||||
# dependencies on demand only if they are needed. This comes in handy if you
|
||||
# want to add own shortcodes that depend on additional code to be loaded.
|
||||
|
|
|
|||
|
|
@ -6,11 +6,11 @@ weight = 24
|
|||
|
||||
The Relearn theme provides configuration options to change your your site's colors, favicon and logo. This allows you to easily align your site visuals to your desired style. Most of these options are exposed thru so called color variants.
|
||||
|
||||
A color variant lets you customize various visual effects of your site like almost any color, used fonts, color schemes of print, syntax highligtning, Mermaid and the OpenAPI shortcode, etc. It contains of a CSS file and optional configuration options in your `config.toml`.
|
||||
A color variant lets you customize various visual effects of your site like almost any color, used fonts, color schemes of print, syntax highligtning, Mermaid and the OpenAPI shortcode, etc. It contains of a CSS file and optional configuration options in your `hugo.toml`.
|
||||
|
||||
The Relearn theme ships with a wide set of different color variants. You can use them as-is, copy them over and use them as a starting point for your customizations or just create completely new variants unique to your site. The [interactive variant generator](basics/generator) may help you with this task.
|
||||
|
||||
Once configured in your `config.toml`, you can select them with the variant selector at the bottom of the menu.
|
||||
Once configured in your `hugo.toml`, you can select them with the variant selector at the bottom of the menu.
|
||||
|
||||
## Change the Variant (Simple) {#theme-variant}
|
||||
|
||||
|
|
@ -18,7 +18,7 @@ Once configured in your `config.toml`, you can select them with the variant sele
|
|||
|
||||
Set the `themeVariant` value to the name of your theme file. That's it! Your site will be displayed in this variant only.
|
||||
|
||||
````toml {title="config.toml"}
|
||||
````toml {title="hugo.toml"}
|
||||
[params]
|
||||
themeVariant = "relearn-light"
|
||||
````
|
||||
|
|
@ -34,7 +34,7 @@ If you want to make changes to a shipped color variant, create a copy in your si
|
|||
|
||||
You can also set multiple variants. In this case, the first variant is the default chosen on first view and a variant selector will be shown in the menu footer if the array contains more than one entry.
|
||||
|
||||
````toml {title="config.toml"}
|
||||
````toml {title="hugo.toml"}
|
||||
[params]
|
||||
themeVariant = [ "relearn-light", "relearn-dark" ]
|
||||
````
|
||||
|
|
@ -51,7 +51,7 @@ You can also cause the site to adjust to your OS settings for light/dark mode. J
|
|||
|
||||
You can use the `auto` value with the single or multiple variants option. If you are using multiple variants, you can drop `auto` at any position in the option's array, but usually it makes sense to set it in the first position and make it the default.
|
||||
|
||||
````toml {title="config.toml"}
|
||||
````toml {title="hugo.toml"}
|
||||
[params]
|
||||
themeVariant = [ "auto", "red" ]
|
||||
````
|
||||
|
|
@ -62,7 +62,7 @@ In the above example, you would end with `red` for light mode and the default of
|
|||
|
||||
If you don't like that behavior, you can explicitly set `themeVariantAuto`. The first entry in the array is the color variant for light mode, the second for dark mode.
|
||||
|
||||
````toml {title="config.toml"}
|
||||
````toml {title="hugo.toml"}
|
||||
[params]
|
||||
themeVariantAuto = [ "learn", "neon" ]
|
||||
````
|
||||
|
|
@ -95,7 +95,7 @@ If you want to switch the syntax highlighting theme together with your color var
|
|||
|
||||
You can use a one of the shipped stylesheet files or use Hugo to generate a file for you. The file must be written to `static/css/chroma-<NAME>.css`. To use it with your color variant you have to define `--CODE-theme: <NAME>` in the color variant stylesheet file.
|
||||
|
||||
For an example, take a look into [`theme-relearn-light.css`](https://github.com/McShelby/hugo-theme-relearn/blob/main/static/css/theme-relearn-light.css) and [`config.toml`](https://github.com/McShelby/hugo-theme-relearn/blob/main/exampleSite/config/_default/config.toml) of the exampleSite.
|
||||
For an example, take a look into [`theme-relearn-light.css`](https://github.com/McShelby/hugo-theme-relearn/blob/main/static/css/theme-relearn-light.css) and [`hugo.toml`](https://github.com/McShelby/hugo-theme-relearn/blob/main/exampleSite/config/_default/hugo.toml) of the exampleSite.
|
||||
|
||||
## Change the Variant (Advanced) {#theme-variant-advanced}
|
||||
|
||||
|
|
@ -105,14 +105,14 @@ Like with the [multiple variants](#multiple-variants) option, you are defining y
|
|||
|
||||
Again, in this case, the first variant is the default chosen on first view and a variant selector will be shown in the menu footer if the array contains more than one entry.
|
||||
|
||||
````toml {title="config.toml"}
|
||||
````toml {title="hugo.toml"}
|
||||
[params]
|
||||
themeVariant = [ "relearn-light", "relearn-dark" ]
|
||||
````
|
||||
|
||||
you now write it that way:
|
||||
|
||||
````toml {title="config.toml"}
|
||||
````toml {title="hugo.toml"}
|
||||
[params]
|
||||
[[params.themeVariant]]
|
||||
identifier = "relearn-light"
|
||||
|
|
@ -132,7 +132,7 @@ The `identifier` option is mandatory and equivalent to the string in the first e
|
|||
|
||||
### Example Configuration of This Site
|
||||
|
||||
````toml {title="config.toml"}
|
||||
````toml {title="hugo.toml"}
|
||||
[params]
|
||||
[[params.themeVariant]]
|
||||
identifier = "relearn-auto"
|
||||
|
|
@ -160,11 +160,11 @@ In case you like a shipped variant but only want to tweak some aspects, you have
|
|||
|
||||
1. Copy and change
|
||||
|
||||
You can copy the shipped variant file from the theme's `static/css` directory to the site's `static/css` directory and either store it with the same name or give it a new name. Edit the settings and save the new file. Afterwards you can use it in your `config.toml` by the choosen name.
|
||||
You can copy the shipped variant file from the theme's `static/css` directory to the site's `static/css` directory and either store it with the same name or give it a new name. Edit the settings and save the new file. Afterwards you can use it in your `hugo.toml` by the choosen name.
|
||||
|
||||
2. Create and import
|
||||
|
||||
You can create a new variant file in the site's `static/css` directory and give it a new name. Import the shipped variant, add the settings you want to change and save the new file. Afterwards you can use it in your `config.toml` by the choosen name.
|
||||
You can create a new variant file in the site's `static/css` directory and give it a new name. Import the shipped variant, add the settings you want to change and save the new file. Afterwards you can use it in your `hugo.toml` by the choosen name.
|
||||
|
||||
For example, you want to use the `relearn-light` variant but want to change the syntax highlightning schema to the one used in the `neon` variant. For that, create a new `static/css/theme-my-branding.css` in your site's directory and add the following lines:
|
||||
|
||||
|
|
@ -178,9 +178,9 @@ In case you like a shipped variant but only want to tweak some aspects, you have
|
|||
}
|
||||
````
|
||||
|
||||
Afterwards put this in your `config.toml` to use your new variant:
|
||||
Afterwards put this in your `hugo.toml` to use your new variant:
|
||||
|
||||
````toml {title="config.toml"}
|
||||
````toml {title="hugo.toml"}
|
||||
[params]
|
||||
themeVariant = "my-branding"
|
||||
````
|
||||
|
|
|
|||
|
|
@ -4,11 +4,11 @@ title = "Configuration"
|
|||
weight = 20
|
||||
+++
|
||||
|
||||
On top of [Hugo's global configuration options](https://gohugo.io/overview/configuration/), the Relearn theme lets you define further options unique to the theme in your `config.toml`. The defaults are written in the comments of each option.
|
||||
On top of [Hugo's global configuration options](https://gohugo.io/overview/configuration/), the Relearn theme lets you define further options unique to the theme in your `hugo.toml`. The defaults are written in the comments of each option.
|
||||
|
||||
Note that some of these options are explained in detail in other sections of this documentation.
|
||||
|
||||
````toml {title="config.toml"}
|
||||
````toml {title="hugo.toml"}
|
||||
[params]
|
||||
{{% include "config/_default/params.toml" %}}
|
||||
````
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ weight = 25
|
|||
|
||||
## Serving your page from a subfolder
|
||||
|
||||
If your site is served from a subfolder, eg. `https://example.com/mysite/`, you have to set the following lines to your `config.toml`
|
||||
If your site is served from a subfolder, eg. `https://example.com/mysite/`, you have to set the following lines to your `hugo.toml`
|
||||
|
||||
````toml
|
||||
baseURL = "https://example.com/mysite/"
|
||||
|
|
@ -17,13 +17,13 @@ Without `canonifyURLs=true` URLs in sublemental pages (like `sitemap.xml`, `rss.
|
|||
|
||||
## 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 `config.toml`:
|
||||
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`:
|
||||
|
||||
````toml
|
||||
relativeURLs = true
|
||||
````
|
||||
|
||||
The theme will append an additional `index.html` to all page bundle links by default to make the page be servable from the file system. If you don't care about the file system and only serve your page via a webserver you can also generate the links without this change by adding this to your `config.toml`
|
||||
The theme will append an additional `index.html` to all page bundle links by default to make the page be servable from the file system. If you don't care about the file system and only serve your page via a webserver you can also generate the links without this change by adding this to your `hugo.toml`
|
||||
|
||||
````toml
|
||||
[params]
|
||||
|
|
@ -36,7 +36,7 @@ If you want to use the search feature from the file system using an older instal
|
|||
|
||||
## Activate search
|
||||
|
||||
If not already present, add the following lines in your `config.toml` file.
|
||||
If not already present, add the following lines in your `hugo.toml` file.
|
||||
|
||||
```toml
|
||||
[outputs]
|
||||
|
|
@ -47,7 +47,7 @@ This will generate a search index file at the root of your public folder ready t
|
|||
|
||||
### Activate dedicated search page
|
||||
|
||||
You can add a dedicated search page for your page by adding the `SEARCHPAGE` outputformat to your home page by adding the following lines in your `config.toml` file. This will cause Hugo to generate a new file `http://example.com/mysite/search.html`.
|
||||
You can add a dedicated search page for your page by adding the `SEARCHPAGE` outputformat to your home page by adding the following lines in your `hugo.toml` file. This will cause Hugo to generate a new file `http://example.com/mysite/search.html`.
|
||||
|
||||
```toml
|
||||
[outputs]
|
||||
|
|
@ -59,14 +59,14 @@ You can access this page by either clicking on the magnifier glass or by typing
|
|||
|
||||
|
||||
{{% notice note %}}
|
||||
To have Hugo create the dedicated search page successfully, you must not generate the URL `http://example.com/mysite/search.html` from your own content. This can happen if you set `uglyURLs=true` in your `config.toml` and defining a Markdown file `content/search.md`.
|
||||
To have Hugo create the dedicated search page successfully, you must not generate the URL `http://example.com/mysite/search.html` from your own content. This can happen if you set `uglyURLs=true` in your `hugo.toml` and defining a Markdown file `content/search.md`.
|
||||
|
||||
To make sure, there is no duplicate content for any given URL of your project, run `hugo --printPathWarnings`.
|
||||
{{% /notice %}}
|
||||
|
||||
## Activate print support
|
||||
|
||||
You can activate print support to add the capability to print whole chapters or even the complete site. Just add the `PRINT` output format to your home, section and page in your `config.toml` as seen below:
|
||||
You can activate print support to add the capability to print whole chapters or even the complete site. Just add the `PRINT` output format to your home, section and page in your `hugo.toml` as seen below:
|
||||
|
||||
```toml
|
||||
[outputs]
|
||||
|
|
@ -78,9 +78,9 @@ You can activate print support to add the capability to print whole chapters or
|
|||
This will add a little printer icon in the top bar. It will switch the page to print preview when clicked. You can then send this page to the printer by using your browser's usual print functionality.
|
||||
|
||||
{{% notice note %}}
|
||||
The resulting URL will not be [configured ugly](https://gohugo.io/templates/output-formats/#configure-output-formats) in terms of [Hugo's URL handling](https://gohugo.io/content-management/urls/#ugly-urls) even if you've set `uglyURLs=true` in your `config.toml`. This is due to the fact that for one mime type only one suffix can be configured.
|
||||
The resulting URL will not be [configured ugly](https://gohugo.io/templates/output-formats/#configure-output-formats) in terms of [Hugo's URL handling](https://gohugo.io/content-management/urls/#ugly-urls) even if you've set `uglyURLs=true` in your `hugo.toml`. This is due to the fact that for one mime type only one suffix can be configured.
|
||||
|
||||
Nevertheless, if you're unhappy with the resulting URLs you can manually redefine `outputFormats.PRINT` in your own `config.toml` to your liking.
|
||||
Nevertheless, if you're unhappy with the resulting URLs you can manually redefine `outputFormats.PRINT` in your own `hugo.toml` to your liking.
|
||||
{{% /notice %}}
|
||||
|
||||
## Home Button Configuration
|
||||
|
|
@ -150,7 +150,7 @@ You can you use this mechanism in your own shortcodes. Say you want to add a sho
|
|||
{{- .Store.Set "hasMyShortcode" true }}
|
||||
````
|
||||
|
||||
1. Add the following snippet to your `config.toml`
|
||||
1. Add the following snippet to your `hugo.toml`
|
||||
|
||||
````go
|
||||
[params.relearn.dependencies]
|
||||
|
|
@ -159,7 +159,7 @@ You can you use this mechanism in your own shortcodes. Say you want to add a sho
|
|||
location = "footer"
|
||||
````
|
||||
|
||||
1. Add the dependency loader file `layouts/partials/dependencies/myshortcode.html`. The loader file will be appended to your header or footer, dependend on the `location` setting in your `config.toml`.
|
||||
1. Add the dependency loader file `layouts/partials/dependencies/myshortcode.html`. The loader file will be appended to your header or footer, dependend on the `location` setting in your `hugo.toml`.
|
||||
|
||||
````html
|
||||
<script src="https://www.unpkg.com/jquery/dist/jquery.js"></script>
|
||||
|
|
@ -167,14 +167,14 @@ You can you use this mechanism in your own shortcodes. Say you want to add a sho
|
|||
|
||||
Character casing is relevant!
|
||||
|
||||
- the `name` setting in your `config.toml` must match the key (that needs to be prefixed with a `has`) you used for the store in your `layouts/shortcodes/myshortcode.html`.
|
||||
- the key on `params.relearn.dependencies` in your `config.toml` must match the base file name of your loader file.
|
||||
- the `name` setting in your `hugo.toml` must match the key (that needs to be prefixed with a `has`) you used for the store in your `layouts/shortcodes/myshortcode.html`.
|
||||
- the key on `params.relearn.dependencies` in your `hugo.toml` must match the base file name of your loader file.
|
||||
|
||||
See the `math`, `mermaid` and `openapi` shortcodes for examples.
|
||||
|
||||
## Output Formats
|
||||
|
||||
Certain parts of the theme can be changed for support of your own [output formats](https://gohugo.io/templates/output-formats/). Eg. if you define a new output format `PLAINTEXT` in your `config.toml`, you can add a file `layouts/partials/header.plaintext.html` to change the way, the page header should look like for that output format.
|
||||
Certain parts of the theme can be changed for support of your own [output formats](https://gohugo.io/templates/output-formats/). Eg. if you define a new output format `PLAINTEXT` in your `hugo.toml`, you can add a file `layouts/partials/header.plaintext.html` to change the way, the page header should look like for that output format.
|
||||
|
||||
## React to Variant Switches in JavaScript
|
||||
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ To better understand this select the `neon` variant and modify the different hea
|
|||
|
||||
Once you've changed a color, the variant selector will show a "My custom variant" entry and your changes are stored in the browser. You can **browse to other pages** and even close the browser **without losing your changes**.
|
||||
|
||||
Once you are satisfied, you can download the new variants file and copy it into your site's `static/css` directory. Afterwards you have to adjust the `themeVariant` parameter in your `config.toml` to your chosen file name.
|
||||
Once you are satisfied, you can download the new variants file and copy it into your site's `static/css` directory. Afterwards you have to adjust the `themeVariant` parameter in your `hugo.toml` to your chosen file name.
|
||||
|
||||
Eg. if your new variants file is named `theme-my-custom-variant.css`, you have to set `themeVariant='my-custom-variant'` to use it.
|
||||
{{% /expand %}}
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ Besides the usual version tags (eg `1.2.3`) there are also tags for the main ver
|
|||
|
||||
## Basic configuration
|
||||
|
||||
When building the website, you can set a theme by using `--theme` option. However, we suggest you modify the configuration file (`config.toml`) and set the theme as the default. You can also add the `[outputs]` section to enable the search functionality.
|
||||
When building the website, you can set a theme by using `--theme` option. However, we suggest you modify the configuration file (`hugo.toml`) and set the theme as the default. You can also add the `[outputs]` section to enable the search functionality.
|
||||
|
||||
```toml
|
||||
# Change the default theme to be use when building the site with Hugo
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ This document shows you what's new in the latest release and flags it with one o
|
|||
|
||||
- {{% badge style="note" title=" " %}}Change{{% /badge %}} The light themes have a bit more contrast for content text and headings. Also the syntaxhighlighting was changed to the more colorful MonokaiLight. This brings the syntaxhighlightning in sync with the corresponding dark theme variants, which are using Monokai. If you dislike this, you can create your own color variant file as [described here](basics/branding#modify-shipped-variants).
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} You now can configure additional options for every theme variant in your `config.toml`. This allows for optional [advanced functionality](basics/branding#theme-variant-advanced). You don't need to change anything as the old configuration options will still work (but may generate warnings now).
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} You now can configure additional options for every theme variant in your `hugo.toml`. This allows for optional [advanced functionality](basics/branding#theme-variant-advanced). You don't need to change anything as the old configuration options will still work (but may generate warnings now).
|
||||
|
||||
The advanced functionality allows you to set an explicit name for a theme variant, set different colors (if you are using monochrome SVGs) or even different icons (handy if you want to adjust colors for PNGs, GIFs or JPGs) and now allows for multiple auto mode variants that adjust to the light/dark preference of your OS settings.
|
||||
|
||||
|
|
@ -32,7 +32,7 @@ This document shows you what's new in the latest release and flags it with one o
|
|||
|
||||
## 5.23.0 (2023-11-03) {#5230}
|
||||
|
||||
- {{% badge style="note" title=" " %}}Change{{% /badge %}} With {{% badge color="fuchsia" icon="fab fa-hackerrank" title=" " %}}0.120.0{{% /badge %}} the author settings move into the `[params]` array in your `config.toml`. Because this collides with the previous way, the theme expected author information, it now adheres to Hugo standards and prints out a warning during built if something is wrong.
|
||||
- {{% badge style="note" title=" " %}}Change{{% /badge %}} With {{% badge color="fuchsia" icon="fab fa-hackerrank" title=" " %}}0.120.0{{% /badge %}} the author settings move into the `[params]` array in your `hugo.toml`. Because this collides with the previous way, the theme expected author information, it now adheres to Hugo standards and prints out a warning during built if something is wrong.
|
||||
|
||||
Change your previous setting from
|
||||
|
||||
|
|
@ -48,7 +48,7 @@ This document shows you what's new in the latest release and flags it with one o
|
|||
author.name = "Hugo"
|
||||
````
|
||||
|
||||
- {{% badge style="note" title=" " %}}Change{{% /badge %}} Taxonomy [term pages](https://gohugo.io/content-management/taxonomies#add-custom-metadata-to-a-taxonomy-or-term) now add the breadcrumb for each listed page. If this gets too crowded for you, you can turn the breadcrumbs off in your `config.toml` by adding `disableTermBreadcrumbs=true`.
|
||||
- {{% badge style="note" title=" " %}}Change{{% /badge %}} Taxonomy [term pages](https://gohugo.io/content-management/taxonomies#add-custom-metadata-to-a-taxonomy-or-term) now add the breadcrumb for each listed page. If this gets too crowded for you, you can turn the breadcrumbs off in your `hugo.toml` by adding `disableTermBreadcrumbs=true`.
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Taxonomy and term pages are now allowed to contain content. This is added inbetween the title and the page list.
|
||||
|
||||
|
|
@ -99,11 +99,11 @@ This document shows you what's new in the latest release and flags it with one o
|
|||
|
||||
In this case it is advised to remove the `title` from the headless branch parent's frontmatter, as it will otherwise appear in your breadcrumbs.
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} It is now possible to overwrite the setting for `collapsibleMenu` of your `config.toml` inside of a page's frontmatter.
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} It is now possible to overwrite the setting for `collapsibleMenu` of your `hugo.toml` inside of a page's frontmatter.
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} If a Mermaid graph is zoomable a button to reset the view is now added to the upper right corner. The button is only shown once the mouse is moved over the graph.
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} It is now possible to remove the root breadcrumb by setting `disableRootBreadcrumb=true` in your `config.toml`.
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} It is now possible to remove the root breadcrumb by setting `disableRootBreadcrumb=true` in your `hugo.toml`.
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The output of the dedicated search page now displays the result's breadcrumb.
|
||||
|
||||
|
|
@ -146,7 +146,7 @@ This document shows you what's new in the latest release and flags it with one o
|
|||
|
||||
For existing variants nothing has changed visually.
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The default values for the [image effects](cont/markdown#image-effects) are [now configurable](cont/imageeffects) for your whole site via `config.toml` or for each page thru frontmatter.
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The default values for the [image effects](cont/markdown#image-effects) are [now configurable](cont/imageeffects) for your whole site via `hugo.toml` or for each page thru frontmatter.
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} This release fixes a long outstanding bug where Mermaid graphs could not be displayed if they were initially hidden - like in collapsed `expand` or inactive `tabs`.
|
||||
|
||||
|
|
@ -186,7 +186,7 @@ This document shows you what's new in the latest release and flags it with one o
|
|||
|
||||
The copy-to-clipboard button for code blocks will now only be displayed if the reader hovers the code block.
|
||||
|
||||
If you dislike this new behavior you can turn it off and revert to the old behavior by adding `[params] disableHoverBlockCopyToClipBoard=true` to your `config.toml`.
|
||||
If you dislike this new behavior you can turn it off and revert to the old behavior by adding `[params] disableHoverBlockCopyToClipBoard=true` to your `hugo.toml`.
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Restored compatibility with Hugo {{% badge color="fuchsia" icon="fab fa-hackerrank" title=" " %}}0.114.0{{% /badge %}} or higher. This does not change the minimum required Hugo version.
|
||||
|
||||
|
|
@ -240,7 +240,7 @@ This document shows you what's new in the latest release and flags it with one o
|
|||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The taxonomy pages received some love in this release, making them better leverage available screen space and adding translation support for the taxonomy names.
|
||||
|
||||
Hugo's default taxonmies `tags` and `categories` are already contained in the theme's i18n files. If you have self-defined taxonomies, you can add translations by adding them to your own i18n files. If you don't provide translations, the singualar and plural forms are taken as configured in your `config.toml`.
|
||||
Hugo's default taxonmies `tags` and `categories` are already contained in the theme's i18n files. If you have self-defined taxonomies, you can add translations by adding them to your own i18n files. If you don't provide translations, the singualar and plural forms are taken as configured in your `hugo.toml`.
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} To give you more flexibility in customizing your article layout a new partial `content-header.html` is introduced.
|
||||
|
||||
|
|
@ -252,7 +252,7 @@ This document shows you what's new in the latest release and flags it with one o
|
|||
2. Show tags between title and content: Overwrite `heading-post.html` and add `{{- partial "tags.html" . }}` to it.
|
||||
3. Show tags below content: Overwrite `content-footer.html` and add `{{- partial "tags.html" . }}` to it.
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The new parameter `breadcrumbSeparator` is now available in your `config.toml` to change the - well - separator of the breadcrumb items. An appropriate default is in place if you do not configure anything.
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The new parameter `breadcrumbSeparator` is now available in your `hugo.toml` to change the - well - separator of the breadcrumb items. An appropriate default is in place if you do not configure anything.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -304,7 +304,7 @@ This document shows you what's new in the latest release and flags it with one o
|
|||
|
||||
- {{% badge style="note" title=" " %}}Change{{% /badge %}} The theme is now capable to visually [adapt to your OS's light/dark mode setting](basics/branding#adjust-to-os-settings).
|
||||
|
||||
This is also the new default setting if you haven't configured `themeVariant` in your `config.toml`.
|
||||
This is also the new default setting if you haven't configured `themeVariant` in your `hugo.toml`.
|
||||
|
||||
Additionally you can configure the variants to be taken for light/dark mode with the new `themeVariantAuto` parameter.
|
||||
|
||||
|
|
@ -372,7 +372,7 @@ This document shows you what's new in the latest release and flags it with one o
|
|||
|
||||
- {{% badge style="note" title=" " %}}Change{{% /badge %}} Absolute links prefixed with `http://` or `https://` are now opened in a separate browser tab.
|
||||
|
||||
You can revert back to the old behavior by defining `externalLinkTarget="_self"` in the `params` section of your `config.toml`.
|
||||
You can revert back to the old behavior by defining `externalLinkTarget="_self"` in the `params` section of your `hugo.toml`.
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The theme now supports [Hugo's module system](https://gohugo.io/hugo-modules/).
|
||||
|
||||
|
|
@ -404,7 +404,7 @@ This document shows you what's new in the latest release and flags it with one o
|
|||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} This release introduces an additional dedicated search page. On this page, displayed search results have more space making it easier scanning thru large number of results.
|
||||
|
||||
To activate this feature, you need to [configure it](basics/customization#activate-dedicated-search-page) in your `config.toml` as a new outputformat `SEARCHPAGE` for the home page. If you don't configure it, no dedicated search page will be accessible and the theme works as before.
|
||||
To activate this feature, you need to [configure it](basics/customization#activate-dedicated-search-page) in your `hugo.toml` as a new outputformat `SEARCHPAGE` for the home page. If you don't configure it, no dedicated search page will be accessible and the theme works as before.
|
||||
|
||||
You can access the search page by either clicking on the magnifier glass or pressing enter inside of the search box.
|
||||
|
||||
|
|
@ -416,7 +416,7 @@ This document shows you what's new in the latest release and flags it with one o
|
|||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} You are now able to turn off the generation of generator meta tags in your HTML head to hide the used versions of Hugo and this theme.
|
||||
|
||||
To [configure this](basics/configuration) in your `config.toml` make sure to set Hugo's `disableHugoGeneratorInject=true` **and** also `[params] disableGeneratorVersion=true`, otherwise Hugo will generate a meta tag into your home page automagically.
|
||||
To [configure this](basics/configuration) in your `hugo.toml` make sure to set Hugo's `disableHugoGeneratorInject=true` **and** also `[params] disableGeneratorVersion=true`, otherwise Hugo will generate a meta tag into your home page automagically.
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Creation of your project gets a little bit faster with this release.
|
||||
|
||||
|
|
@ -440,9 +440,9 @@ This document shows you what's new in the latest release and flags it with one o
|
|||
|
||||
## 5.4.0 (2022-11-01) {#540}
|
||||
|
||||
- {{% badge style="note" title=" " %}}Change{{% /badge %}} [With the proper settings](basics/customization#serving-your-page-from-the-filesystem) in your `config.toml` your page is now servable from the local file system using `file://` URLs.
|
||||
- {{% badge style="note" title=" " %}}Change{{% /badge %}} [With the proper settings](basics/customization#serving-your-page-from-the-filesystem) in your `hugo.toml` your page is now servable from the local file system using `file://` URLs.
|
||||
|
||||
Please note that the searchbox will only work for this if you reconfigure your outputformat for the homepage in your `config.toml` from `JSON` to `SEARCH`. The now deprecated `JSON` outputformat still works as before, so there is no need to reconfigure your installation if it is only served from `http://` or `https://`.
|
||||
Please note that the searchbox will only work for this if you reconfigure your outputformat for the homepage in your `hugo.toml` from `JSON` to `SEARCH`. The now deprecated `JSON` outputformat still works as before, so there is no need to reconfigure your installation if it is only served from `http://` or `https://`.
|
||||
|
||||
- {{% badge style="note" title=" " %}}Change{{% /badge %}} The [`button` shortcode](shortcodes/button) has a new parameter `target` to set the destination frame/window for the URL to open. If not given, it defaults to a new window/tab for external URLs or is not set at all for internal URLs. Previously even internal URLs where opened in a new window/tab.
|
||||
|
||||
|
|
@ -466,7 +466,7 @@ This document shows you what's new in the latest release and flags it with one o
|
|||
|
||||
## 5.2.0 (2022-08-03) {#520}
|
||||
|
||||
- {{% badge style="note" title=" " %}}Change{{% /badge %}} If you've set `collapsibleMenu = true` in your `config.toml`, the menu will be expanded if a search term is found in a collapsed submenu. The menu will return to its initial collapse state once the search term does not match any submenus.
|
||||
- {{% badge style="note" title=" " %}}Change{{% /badge %}} If you've set `collapsibleMenu = true` in your `hugo.toml`, the menu will be expanded if a search term is found in a collapsed submenu. The menu will return to its initial collapse state once the search term does not match any submenus.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -476,7 +476,7 @@ This document shows you what's new in the latest release and flags it with one o
|
|||
|
||||
- {{% badge style="note" title=" " %}}Change{{% /badge %}} Because the print preview URLs were non deterministic for normal pages in comparison to page bundles, this is now changed. Each print preview is now accessible by adding a `index.print.html` to the default URL.
|
||||
|
||||
You can revert this behavior by overwriting the PRINT output format setting in your `config.toml`to:
|
||||
You can revert this behavior by overwriting the PRINT output format setting in your `hugo.toml`to:
|
||||
|
||||
````toml
|
||||
[outputFormats]
|
||||
|
|
@ -523,7 +523,7 @@ This document shows you what's new in the latest release and flags it with one o
|
|||
|
||||
- {{% badge style="note" title=" " %}}Change{{% /badge %}} Previously, if the [`tabs` shortcode](shortcodes/tabs) could not find a tab item because, the tabs ended up empty. Now the first tab is selected instead.
|
||||
|
||||
- {{% badge style="note" title=" " %}}Change{{% /badge %}} The `landingPageURL` was removed from `config.toml`. You can safely remove this as well from your configuration as it is not used anymore. The theme will detect the landing page URL automatically and will point to the project's homepage. If you want to support a different link, overwrite the `logo.html` partial.
|
||||
- {{% badge style="note" title=" " %}}Change{{% /badge %}} The `landingPageURL` was removed from `hugo.toml`. You can safely remove this as well from your configuration as it is not used anymore. The theme will detect the landing page URL automatically and will point to the project's homepage. If you want to support a different link, overwrite the `logo.html` partial.
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} All shortcodes can now be also called from your partials. Examples for this are added to the documentation of each shortcode.
|
||||
|
||||
|
|
@ -561,9 +561,9 @@ This document shows you what's new in the latest release and flags it with one o
|
|||
|
||||
- {{% badge style="warning" title=" " %}}Breaking{{% /badge %}} If you had previously overwritten the `custom-footer.html` partial to add visual elements below the content of your page, you have to move this content to the new partial `content-footer.html`. `custom-footer.html` was never meant to contain HTML other than additional styles and JavaScript.
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} If you prefer expandable/collapsible menu items, you can now set `collapsibleMenu=true` in your `config.toml`. This will add arrows to all menu items that contain sub menus. The menu will expand/collapse without navigation if you click on an arrow.
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} If you prefer expandable/collapsible menu items, you can now set `collapsibleMenu=true` in your `hugo.toml`. This will add arrows to all menu items that contain sub menus. The menu will expand/collapse without navigation if you click on an arrow.
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} You can activate [print support](basics/customization#activate-print-support) in your `config.toml` to add the capability to print whole chapters or even the complete site.
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} You can activate [print support](basics/customization#activate-print-support) in your `hugo.toml` to add the capability to print whole chapters or even the complete site.
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Translation into Traditional Chinese.
|
||||
|
||||
|
|
@ -603,7 +603,7 @@ This document shows you what's new in the latest release and flags it with one o
|
|||
|
||||
- {{% badge style="warning" title=" " %}}Breaking{{% /badge %}} We have changed the default colors from the original Learn theme (the purple menu header) to the Relearn defaults (the light green menu header) as used in the official documentation.
|
||||
|
||||
This change will only affect your installation if you've not set the `themeVariant` parameter in your `config.toml`. [If you still want to use the Learn color variant](basics/branding#theme-variant), you have to explicitly set `themeVariant="learn"` in your `config.toml`.
|
||||
This change will only affect your installation if you've not set the `themeVariant` parameter in your `hugo.toml`. [If you still want to use the Learn color variant](basics/branding#theme-variant), you have to explicitly set `themeVariant="learn"` in your `hugo.toml`.
|
||||
|
||||
Note, that this will also affect your site if viewed with Internet Explorer 11 but in this case it can not be reconfigured as Internet Explorer does not support CSS variables.
|
||||
|
||||
|
|
@ -619,7 +619,7 @@ This document shows you what's new in the latest release and flags it with one o
|
|||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} To make the creation of new variants easier for you, we've added a new interactive [theme variant generator](basics/generator). This feature will not work with Internet Explorer 11.
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} You can now configure multiple color variants in your `config.toml`. In this case, the first variant is the default chosen on first view and a variant selector will be shown in the menu footer. See the [documentation](basics/branding#multiple-variants) for configuration.
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} You can now configure multiple color variants in your `hugo.toml`. In this case, the first variant is the default chosen on first view and a variant selector will be shown in the menu footer. See the [documentation](basics/branding#multiple-variants) for configuration.
|
||||
|
||||
Note, that the new variant selector will not work with Internet Explorer 11 as it does not support CSS variables. Therefore, the variant selector will not be displayed with Internet Explorer 11.
|
||||
|
||||
|
|
@ -663,7 +663,7 @@ This document shows you what's new in the latest release and flags it with one o
|
|||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The theme now supports favicons served from `static/images/` named as `favicon` or `logo` in SVG, PNG or ICO format [out of the box](basics/customization#change-the-favicon). An overridden partial `layouts/partials/favicon.html` may not be necessary anymore in most cases.
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} You can hide the table of contents menu for the whole site by setting the `disableToc` option in your `config.toml`. For an example see [the example configuration](basics/configuration).
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} You can hide the table of contents menu for the whole site by setting the `disableToc` option in your `hugo.toml`. For an example see [the example configuration](basics/configuration).
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -675,7 +675,7 @@ This document shows you what's new in the latest release and flags it with one o
|
|||
|
||||
## 2.6.0 (2021-10-21) {#260}
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Your site can now be served from a subfolder if you set `baseURL` and `canonifyURLs=true` in your `config.toml`. See the [documentation](basics/customization#serving-your-page-from-a-subfolder) for a detailed example.
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Your site can now be served from a subfolder if you set `baseURL` and `canonifyURLs=true` in your `hugo.toml`. See the [documentation](basics/customization#serving-your-page-from-a-subfolder) for a detailed example.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -689,9 +689,9 @@ This document shows you what's new in the latest release and flags it with one o
|
|||
|
||||
- {{% badge style="note" title=" " %}}Change{{% /badge %}} Creation of customized stylesheets was simplified down to only contain the CSS variables. Everything else can and should be deleted from your custom stylesheet to assure everything works fine. For the predefined stylesheet variants, this change is already included.
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Hidden pages are displayed by default in their according tags page. You can now turn off this behavior by setting `disableTagHiddenPages=true` in your `config.toml`.
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Hidden pages are displayed by default in their according tags page. You can now turn off this behavior by setting `disableTagHiddenPages=true` in your `hugo.toml`.
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} You can define the expansion state of your menus for the whole site by setting the `alwaysopen` option in your `config.toml`. Please see further [documentation](cont/pages#override-expand-state-rules-for-menu-entries) for possible values and default behavior.
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} You can define the expansion state of your menus for the whole site by setting the `alwaysopen` option in your `hugo.toml`. Please see further [documentation](cont/pages#override-expand-state-rules-for-menu-entries) for possible values and default behavior.
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} New frontmatter `ordersectionsby` option to change immediate children sorting in menu and `children` shortcode. Possible values are `title` or `weight`.
|
||||
|
||||
|
|
@ -709,7 +709,7 @@ This document shows you what's new in the latest release and flags it with one o
|
|||
|
||||
## 2.2.0 (2021-09-09) {#220}
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Hidden pages are displayed by default in the sitemap generated by Hugo and are therefore visible for search engine indexing. You can now turn off this behavior by setting `disableSeoHiddenPages=true` in your `config.toml`.
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Hidden pages are displayed by default in the sitemap generated by Hugo and are therefore visible for search engine indexing. You can now turn off this behavior by setting `disableSeoHiddenPages=true` in your `hugo.toml`.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -719,7 +719,7 @@ This document shows you what's new in the latest release and flags it with one o
|
|||
|
||||
- {{% badge style="note" title=" " %}}Change{{% /badge %}} In case the site's structure contains additional *.md files not part of the site (eg files that are meant to be included by site pages - see `CHANGELOG.md` in the exampleSite), they will now be ignored by the search.
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Hidden pages are indexed for the site search by default. You can now turn off this behavior by setting `disableSearchHiddenPages=true` in your `config.toml`.
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Hidden pages are indexed for the site search by default. You can now turn off this behavior by setting `disableSearchHiddenPages=true` in your `hugo.toml`.
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} If a search term is found in an `expand` shortcode, the expand will be opened.
|
||||
|
||||
|
|
@ -761,7 +761,7 @@ This document shows you what's new in the latest release and flags it with one o
|
|||
|
||||
- {{% badge style="warning" title=" " %}}Breaking{{% /badge %}} [Mermaid](shortcodes/mermaid) diagrams can now be panned and zoomed. This isn't configurable yet.
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} [`Mermaid`](shortcodes/mermaid#configuration) config options can be set in `config.toml`.
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} [`Mermaid`](shortcodes/mermaid#configuration) config options can be set in `hugo.toml`.
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -128,4 +128,4 @@ Take a look at the existing archetypes of this theme to get an idea how to utili
|
|||
|
||||
#### Output formats
|
||||
|
||||
Each hook file can be overridden of a specific [output format](https://gohugo.io/templates/output-formats/). Eg. if you define a new output format `PLAINTEXT` in your `config.toml`, you can add a file `layouts/partials/archetypes/default.plaintext.html` to change the way how normal content is written for that output format.
|
||||
Each hook file can be overridden of a specific [output format](https://gohugo.io/templates/output-formats/). Eg. if you define a new output format `PLAINTEXT` in your `hugo.toml`, you can add a file `layouts/partials/archetypes/default.plaintext.html` to change the way how normal content is written for that output format.
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ Each Hugo page has to define a [frontmatter](https://gohugo.io/content/front-mat
|
|||
# Default: not set
|
||||
# This is used for generating social media meta information for the opengraph
|
||||
# protocol and twitter cards.
|
||||
# If not set, the set value of your site's config.toml is used.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
images = [ "images/hero.png" ]
|
||||
|
||||
# The title of your page.
|
||||
|
|
@ -30,7 +30,7 @@ title = "Example Page"
|
|||
# Default: not set
|
||||
# This is used for generating HTML meta tags, social media meta information
|
||||
# for the opengraph protocol and twitter cards.
|
||||
# If not set, the set value of your site's config.toml is used for the html
|
||||
# If not set, the set value of your site's hugo.toml is used for the html
|
||||
# meta tag, social media meta information for the opengraph protocol and
|
||||
# twitter cards.
|
||||
description = ""
|
||||
|
|
@ -46,7 +46,7 @@ description = ""
|
|||
# Hide the table of contents button.
|
||||
# Default: false
|
||||
# If the TOC button is hidden, also the keyboard shortcut is disabled.
|
||||
# If not set, the set value of your site's config.toml is used.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
disableToc = false
|
||||
|
||||
# Hide the breadcrumbs.
|
||||
|
|
@ -152,7 +152,7 @@ LastModifierEmail = ""
|
|||
# displayed on screen. If you dislike this behavior, you can reconfigure it
|
||||
# here.
|
||||
# Note that lines always wrap in print mode regardless of this option.
|
||||
# If not set, the set value of your site's config.toml is used or given as a
|
||||
# If not set, the set value of your site's hugo.toml is used or given as a
|
||||
# parameter to individual code blocks.
|
||||
highlightWrap = true
|
||||
|
||||
|
|
@ -163,7 +163,7 @@ highlightWrap = true
|
|||
# Image effects.
|
||||
# See the documentation for how you can even add your own arbitrary effects to
|
||||
# the list.
|
||||
# All effect values default to the values of your site's config.toml and can be
|
||||
# All effect values default to the values of your site's hugo.toml and can be
|
||||
# overridden thru URL parameter given to the image. See the documentation for
|
||||
# details.
|
||||
|
||||
|
|
@ -181,7 +181,7 @@ imageEffects.shadow = false
|
|||
# Initialization options for MathJax.
|
||||
# Default: not set
|
||||
# A JSON value. See the MathJaxdocumentation for possible parameter.
|
||||
# If not set, the set value of your site's config.toml is used.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
mathJaxInitialize = "{}"
|
||||
|
||||
# Only load MathJax if needed.
|
||||
|
|
@ -192,14 +192,14 @@ mathJaxInitialize = "{}"
|
|||
# codefence is involved and the library is not loaded by default. In this case
|
||||
# you can set `disableMathJax=false` in your frontmatter to force the library to
|
||||
# be loaded.
|
||||
# If not set, the set value of your site's config.toml is used.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
disableMathJax = true
|
||||
|
||||
# URL for external MathJax library.
|
||||
# Default: not set
|
||||
# Specifies the remote location of the MathJax library. By default the shipped
|
||||
# version will be used.
|
||||
# If not set, the set value of your site's config.toml is used.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
customMathJaxURL = "" # "https://unpkg.com/mathjax/es5/tex-mml-chtml.js"
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
|
|
@ -210,14 +210,14 @@ customMathJaxURL = "" # "https://unpkg.com/mathjax/es5/tex-mml-chtml.js"
|
|||
# Default: false
|
||||
# For huge graphs it can be helpful to make them zoomable. Zoomable graphs come
|
||||
# with a reset button for the zoom.
|
||||
# If not set, the set value of your site's config.toml is used or given as a
|
||||
# If not set, the set value of your site's hugo.toml is used or given as a
|
||||
# parameter to individual graphs.
|
||||
mermaidZoom = true
|
||||
|
||||
# Initialization options for Mermaid.
|
||||
# Default: not set
|
||||
# A JSON value. See the Mermaid documentation for possible parameter.
|
||||
# If not set, the set value of your site's config.toml is used.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
mermaidInitialize = "{ \"securityLevel\": \"loose\" }"
|
||||
|
||||
# Only load Mermaid if needed.
|
||||
|
|
@ -228,14 +228,14 @@ mermaidInitialize = "{ \"securityLevel\": \"loose\" }"
|
|||
# codefence is involved and the library is not loaded by default. In this case
|
||||
# you can set `disableMermaid=false` in your frontmatter to force the library to
|
||||
# be loaded.
|
||||
# If not set, the set value of your site's config.toml is used.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
disableMermaid = true
|
||||
|
||||
# URL for external Mermaid library.
|
||||
# Default: not set
|
||||
# Specifies the remote location of the Mermaid library. By default the shipped
|
||||
# version will be used.
|
||||
# If not set, the set value of your site's config.toml is used.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
customMermaidURL = "" # "https://unpkg.com/mermaid/dist/mermaid.min.js"
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
|
|
@ -250,14 +250,14 @@ customMermaidURL = "" # "https://unpkg.com/mermaid/dist/mermaid.min.js"
|
|||
# codefence is involved and the library is not loaded by default. In this case
|
||||
# you can set `disableOpenapi=false` in your frontmatter to force the library to
|
||||
# be loaded.
|
||||
# If not set, the set value of your site's config.toml is used.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
disableOpenapi = true
|
||||
|
||||
# URL for external OpenAPI library.
|
||||
# Default: not set
|
||||
# Specifies the remote location of the OpenAPI library. By default the shipped
|
||||
# version will be used.
|
||||
# If not set, the set value of your site's config.toml is used.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
customOpenapiURL = "" # "https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"
|
||||
+++
|
||||
````
|
||||
|
|
@ -331,7 +331,7 @@ For this, open `content/level-one/_index.md` and add the following frontmatter
|
|||
|
||||
````toml
|
||||
+++
|
||||
collapsibleMenu = true # this adds the expander to the menu entry if not already set in your config.toml
|
||||
collapsibleMenu = true # this adds the expander to the menu entry if not already set in your hugo.toml
|
||||
[_build]
|
||||
render = "never" # no page will be generated so the page does not have a url
|
||||
+++
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ The Relearn theme is fully compatible with Hugo multilingual mode.
|
|||
|
||||
## Basic configuration
|
||||
|
||||
After learning [how Hugo handle multilingual websites](https://gohugo.io/content-management/multilingual), define your languages in your `config.toml` file.
|
||||
After learning [how Hugo handle multilingual websites](https://gohugo.io/content-management/multilingual), define your languages in your `hugo.toml` file.
|
||||
|
||||
For example with current English and Piratized English website.
|
||||
|
||||
|
|
@ -72,7 +72,7 @@ You'll see error reports in your browsers console log for each unsupported langu
|
|||
|
||||
### Search with mixed language support
|
||||
|
||||
In case your page's content contains text in multiple languages (e.g. you are writing a Russian documentation for your english API), you can add those languages to your `config.toml` to broaden search.
|
||||
In case your page's content contains text in multiple languages (e.g. you are writing a Russian documentation for your english API), you can add those languages to your `hugo.toml` to broaden search.
|
||||
|
||||
```toml
|
||||
[params]
|
||||
|
|
@ -95,7 +95,7 @@ To override these values, create a new file in your local i18n folder `i18n/<idl
|
|||
|
||||
Switching the language in the browser is a great feature, but for some reasons you may want to disable it.
|
||||
|
||||
Just set `disableLanguageSwitchingButton=true` in your `config.toml`
|
||||
Just set `disableLanguageSwitchingButton=true` in your `hugo.toml`
|
||||
|
||||
```toml
|
||||
[params]
|
||||
|
|
|
|||
|
|
@ -7,13 +7,13 @@ The theme supports non-standard [image effects](cont/markdown#image-effects).
|
|||
|
||||
As described, you can add this to the URL query parameter, but this may be cumbersome to do it consistently for the whole page.
|
||||
|
||||
Instead, you can configure the defaults in your `config.toml` aswell as overriding these default in the pages frontmatter.
|
||||
Instead, you can configure the defaults in your `hugo.toml` aswell as overriding these default in the pages frontmatter.
|
||||
|
||||
Explicitly set URL query parameter will override the defaults in effect for a page.
|
||||
|
||||
Without any settings in your `config.toml` this defaults to
|
||||
Without any settings in your `hugo.toml` this defaults to
|
||||
|
||||
````toml {title="config.toml"}
|
||||
````toml {title="hugo.toml"}
|
||||
[params]
|
||||
[params.imageEffects]
|
||||
border = false
|
||||
|
|
@ -54,8 +54,8 @@ This ends up in the following HTML where the parameter are converted to CSS clas
|
|||
|
||||
## Extending
|
||||
|
||||
As you can see in the above example, the `bg-white` parameter is not initially supported in the themes default settings. Nevertheless you are free to define arbitrary parameter by just adding them to the URL query parameter or set them in your `config.toml` or pages frontmatter.
|
||||
As you can see in the above example, the `bg-white` parameter is not initially supported in the themes default settings. Nevertheless you are free to define arbitrary parameter by just adding them to the URL query parameter or set them in your `hugo.toml` or pages frontmatter.
|
||||
|
||||
{{% notice note %}}
|
||||
If no extended parameter like `bg-white` in the example is set on the URL, a `class="nobg-white"` in the HTML will only be generated if a default value was set in the `config.toml` or pages frontmatter.
|
||||
If no extended parameter like `bg-white` in the example is set on the URL, a `class="nobg-white"` in the HTML will only be generated if a default value was set in the `hugo.toml` or pages frontmatter.
|
||||
{{% /notice %}}
|
||||
|
|
|
|||
|
|
@ -566,7 +566,7 @@ Images can also be linked by reference ID to later define the URL location. This
|
|||
|
||||
### Image Effects
|
||||
|
||||
This theme allows additional non-standard formatting by setting query parameter at the end of the image URL. The default [behavior is configurable](cont/imageeffects) thru your `config.toml` or frontmatter parameter.
|
||||
This theme allows additional non-standard formatting by setting query parameter at the end of the image URL. The default [behavior is configurable](cont/imageeffects) thru your `hugo.toml` or frontmatter parameter.
|
||||
|
||||
#### Resizing
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ You can define additional menu entries or shortcuts in the navigation menu witho
|
|||
|
||||
## Basic configuration
|
||||
|
||||
Edit the website configuration `config.toml` and add a `[[menu.shortcuts]]` entry for each link your want to add.
|
||||
Edit the website configuration `hugo.toml` and add a `[[menu.shortcuts]]` entry for each link your want to add.
|
||||
|
||||
Example from the current website:
|
||||
|
||||
|
|
@ -54,7 +54,7 @@ Read more about [hugo menu](https://gohugo.io/extras/menus/) and [hugo i18n tran
|
|||
|
||||
## Configuration for Multilingual mode {#i18n}
|
||||
|
||||
When using a multilingual website, you can set different menus for each language. In the `config.toml` file, prefix your menu configuration by `Languages.<language-id>`.
|
||||
When using a multilingual website, you can set different menus for each language. In the `hugo.toml` file, prefix your menu configuration by `Languages.<language-id>`.
|
||||
|
||||
Example from the current website:
|
||||
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ Each item is a link to a taxonomy page displaying all the articles with the give
|
|||
|
||||
## List all the tags
|
||||
|
||||
In the `config.toml` file you can add a shortcut to display all the tags and categories
|
||||
In the `hugo.toml` file you can add a shortcut to display all the tags and categories
|
||||
|
||||
```toml
|
||||
[[menu.shortcuts]]
|
||||
|
|
|
|||
|
|
@ -202,7 +202,7 @@ If your JavaScript action does not change the focus afterwards, make sure to cal
|
|||
|
||||
#### Button within a `form` Element
|
||||
|
||||
To use native HTML elements in your Markdown, add this in your `config.toml`
|
||||
To use native HTML elements in your Markdown, add this in your `hugo.toml`
|
||||
|
||||
````toml
|
||||
[markup.goldmark.renderer]
|
||||
|
|
|
|||
|
|
@ -81,16 +81,16 @@ print("Hello World!")
|
|||
|-----------------------|--------- | -----------------|-------------|
|
||||
| **type** | 1 | _<empty>_ | The language of the code to highlight. Choose from one of the [supported languages](https://gohugo.io/content-management/syntax-highlighting/#list-of-chroma-highlighting-languages). Case-insensitive. |
|
||||
| **title** | | _<empty>_ | **Extension**. Arbitrary title for code. This displays the code like a [single tab](shortcodes/tab) if `hl_inline=false` (which is Hugos default). |
|
||||
| **wrap** | | see notes | **Extension**. When `true` the content may wrap on long lines otherwise it will be scrollable.<br><br>The default value can be set in your `config.toml` and overwritten via frontmatter. [See below](#configuration). |
|
||||
| **wrap** | | see notes | **Extension**. When `true` the content may wrap on long lines otherwise it will be scrollable.<br><br>The default value can be set in your `hugo.toml` and overwritten via frontmatter. [See below](#configuration). |
|
||||
| **options** | 2 | _<empty>_ | An optional, comma-separated list of zero or more [Hugo supported options](https://gohugo.io/functions/highlight/#options) as well as extension parameter from this table. |
|
||||
| _**<option>**_ | | _<empty>_ | Any of [Hugo's supported options](https://gohugo.io/functions/highlight/#options). |
|
||||
| _**<content>**_ | | _<empty>_ | Your code to highlight. |
|
||||
|
||||
## Configuration
|
||||
|
||||
Default values for [Hugo's supported options](https://gohugo.io/functions/highlight/#options) can be set via [goldmark settings](https://gohugo.io/getting-started/configuration-markup/#highlight) in your `config.toml`
|
||||
Default values for [Hugo's supported options](https://gohugo.io/functions/highlight/#options) can be set via [goldmark settings](https://gohugo.io/getting-started/configuration-markup/#highlight) in your `hugo.toml`
|
||||
|
||||
Default values for extension options can be set via params settings in your `config.toml` or be overwritten by frontmatter for each individual page.
|
||||
Default values for extension options can be set via params settings in your `hugo.toml` or be overwritten by frontmatter for each individual page.
|
||||
|
||||
### Global Configuration File
|
||||
|
||||
|
|
@ -137,7 +137,7 @@ highlightWrap = true
|
|||
|
||||
### Line Numbers with Starting Offset
|
||||
|
||||
As mentioned above, line numbers in a `table` layout will shift if code is wrapping, so better use `inline`. To make things easier for you, set `lineNumbersInTable = false` in your `config.toml` and add `lineNos = true` when calling the shortcode instead of the specific values `table` or `inline`.
|
||||
As mentioned above, line numbers in a `table` layout will shift if code is wrapping, so better use `inline`. To make things easier for you, set `lineNumbersInTable = false` in your `hugo.toml` and add `lineNos = true` when calling the shortcode instead of the specific values `table` or `inline`.
|
||||
|
||||
````go
|
||||
{{</* highlight lineNos="true" lineNoStart="666" type="py" */>}}
|
||||
|
|
|
|||
|
|
@ -96,7 +96,7 @@ Built with <i class="fas fa-heart"></i> by Relearn and Hugo
|
|||
|
||||
Built with <i class="fas fa-heart"></i> by Relearn and Hugo
|
||||
|
||||
To use these native HTML elements in your Markdown, add this in your `config.toml`:
|
||||
To use these native HTML elements in your Markdown, add this in your `hugo.toml`:
|
||||
|
||||
````toml
|
||||
[markup.goldmark.renderer]
|
||||
|
|
|
|||
|
|
@ -61,9 +61,9 @@ $$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \
|
|||
|
||||
## Configuration
|
||||
|
||||
MathJax is configured with default settings. You can customize MathJax's default settings for all of your files thru a JSON object in your `config.toml` or override these settings per page thru your pages frontmatter.
|
||||
MathJax is configured with default settings. You can customize MathJax's default settings for all of your files thru a JSON object in your `hugo.toml` or override these settings per page thru your pages frontmatter.
|
||||
|
||||
The JSON object of your `config.toml` / frontmatter is forwarded into MathJax's configuration object.
|
||||
The JSON object of your `hugo.toml` / frontmatter is forwarded into MathJax's configuration object.
|
||||
|
||||
See [MathJax documentation](https://docs.mathjax.org/en/latest/options/index.html) for all allowed settings.
|
||||
|
||||
|
|
|
|||
|
|
@ -71,13 +71,13 @@ The generated graphs can be be panned by dragging them and zoomed by using the m
|
|||
|
||||
## Configuration
|
||||
|
||||
Mermaid is configured with default settings. You can customize Mermaid's default settings for all of your files thru a JSON object in your `config.toml`, override these settings per page thru your pages frontmatter or override these setting per diagramm thru [diagram directives](https://mermaid-js.github.io/mermaid/#/directives?id=directives).
|
||||
Mermaid is configured with default settings. You can customize Mermaid's default settings for all of your files thru a JSON object in your `hugo.toml`, override these settings per page thru your pages frontmatter or override these setting per diagramm thru [diagram directives](https://mermaid-js.github.io/mermaid/#/directives?id=directives).
|
||||
|
||||
The JSON object of your `config.toml` / frontmatter is forwarded into Mermaid's `mermaid.initialize()` function.
|
||||
The JSON object of your `hugo.toml` / frontmatter is forwarded into Mermaid's `mermaid.initialize()` function.
|
||||
|
||||
See [Mermaid documentation](https://mermaid-js.github.io/mermaid/#/Setup?id=mermaidapi-configuration-defaults) for all allowed settings.
|
||||
|
||||
The `theme` setting can also be set by your used color variant. This will be the sitewide default and can - again - be overridden by your settings in `config.toml`, frontmatter or diagram directives.
|
||||
The `theme` setting can also be set by your used color variant. This will be the sitewide default and can - again - be overridden by your settings in `hugo.toml`, frontmatter or diagram directives.
|
||||
|
||||
### Global Configuration File
|
||||
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ While the examples are using shortcodes with named parameter you are free to use
|
|||
|
||||
## Examples
|
||||
|
||||
### `editURL` from `config.toml`
|
||||
### `editURL` from `hugo.toml`
|
||||
|
||||
```go
|
||||
`editURL` value: {{%/* siteparam name="editURL" */%}}
|
||||
|
|
@ -54,14 +54,14 @@ While the examples are using shortcodes with named parameter you are free to use
|
|||
|
||||
### Nested parameter with Markdown and HTML formatting
|
||||
|
||||
To use formatted parameter, add this in your `config.toml`:
|
||||
To use formatted parameter, add this in your `hugo.toml`:
|
||||
|
||||
````toml
|
||||
[markup.goldmark.renderer]
|
||||
unsafe = true
|
||||
````
|
||||
|
||||
{{% tab title="config.toml" %}}
|
||||
{{% tab title="hugo.toml" %}}
|
||||
````toml
|
||||
[params]
|
||||
[params.siteparam.test]
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
+++
|
||||
+++
|
||||
|
||||
You can define optional content in your overridden taxonomy page. Aswell you can define optional `title` and `singulartitle` that will override the values from your `config.toml` or of your translation files.
|
||||
You can define optional content in your overridden taxonomy page. Aswell you can define optional `title` and `singulartitle` that will override the values from your `hugo.toml` or of your translation files.
|
||||
|
||||
## Just an example heading
|
||||
|
||||
|
|
|
|||
|
|
@ -19,9 +19,9 @@ set config=--environment testing
|
|||
if exist "config\testing" (
|
||||
rem Seems we are in the themes exampleSite, no need to copy anything
|
||||
) else if exist "config.toml" (
|
||||
set config=--config config.toml,..\hugo-theme-relearn\exampleSite\config\testing\config.toml
|
||||
set config=--config config.toml,..\hugo-theme-relearn\exampleSite\config\testing\hugo.toml
|
||||
) else if exist "hugo.toml" (
|
||||
set config=--config hugo.toml,..\hugo-theme-relearn\exampleSite\config\testing\config.toml
|
||||
set config=--config hugo.toml,..\hugo-theme-relearn\exampleSite\config\testing\hugo.toml
|
||||
) else if exist "config" (
|
||||
copy /e /i /y "..\hugo-theme-relearn\exampleSite\config\testing" "config\testing"
|
||||
) else if exist "hugo" (
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
{{- $authorName = . }}
|
||||
{{- end }}
|
||||
{{- else }}
|
||||
{{- warnf "%q: DEPRECATED usage of 'params.author' config parameter found, replace it with `params.author.name` in your config.toml; see https://mcshelby.github.io/hugo-theme-relearn/basics/migration#5230" .File.Filename }}
|
||||
{{- warnf "%q: DEPRECATED usage of 'params.author' config parameter found, replace it with `params.author.name` in your hugo.toml; see https://mcshelby.github.io/hugo-theme-relearn/basics/migration#5230" .File.Filename }}
|
||||
{{- $authorName = .Site.Params.author }}
|
||||
{{- end }}
|
||||
{{- else }}
|
||||
|
|
|
|||
|
|
@ -24,9 +24,9 @@
|
|||
--CODE-INLINE-BORDER-color: rgba( 70, 70, 70, 1 ); /* border color of inline code */
|
||||
|
||||
--BROWSER-theme: dark; /* name of the theme for browser scrollbars of the main section */
|
||||
--MERMAID-theme: dark; /* name of the default Mermaid theme for this variant, can be overridden in config.toml */
|
||||
--OPENAPI-theme: dark; /* name of the default OpenAPI theme for this variant, can be overridden in config.toml */
|
||||
--OPENAPI-CODE-theme: tomorrow-night; /* name of the default OpenAPI code theme for this variant, can be overridden in config.toml */
|
||||
--MERMAID-theme: dark; /* name of the default Mermaid theme for this variant, can be overridden in hugo.toml */
|
||||
--OPENAPI-theme: dark; /* name of the default OpenAPI theme for this variant, can be overridden in hugo.toml */
|
||||
--OPENAPI-CODE-theme: tomorrow-night; /* name of the default OpenAPI code theme for this variant, can be overridden in hugo.toml */
|
||||
|
||||
--MENU-HEADER-BG-color: rgba( 0, 0, 0, 0 ); /* background color of menu header */
|
||||
|
||||
|
|
|
|||
|
|
@ -17,9 +17,9 @@
|
|||
--CODE-INLINE-BORDER-color: rgba( 248, 232, 200, 1 ); /* border color of inline code */
|
||||
|
||||
--BROWSER-theme: light; /* name of the theme for browser scrollbars of the main section */
|
||||
--MERMAID-theme: default; /* name of the default Mermaid theme for this variant, can be overridden in config.toml */
|
||||
--OPENAPI-theme: light; /* name of the default OpenAPI theme for this variant, can be overridden in config.toml */
|
||||
--OPENAPI-CODE-theme: idea; /* name of the default OpenAPI code theme for this variant, can be overridden in config.toml */
|
||||
--MERMAID-theme: default; /* name of the default Mermaid theme for this variant, can be overridden in hugo.toml */
|
||||
--OPENAPI-theme: light; /* name of the default OpenAPI theme for this variant, can be overridden in hugo.toml */
|
||||
--OPENAPI-CODE-theme: idea; /* name of the default OpenAPI code theme for this variant, can be overridden in hugo.toml */
|
||||
|
||||
--MENU-HEADER-BG-color: rgba( 0, 0, 0, 0 ); /* background color of menu header */
|
||||
--MENU-HEADER-SEPARATOR-color: rgba( 96, 96, 96, 1 ); /* separator color between menu header and menu */
|
||||
|
|
|
|||
|
|
@ -17,9 +17,9 @@
|
|||
--CODE-INLINE-BORDER-color: rgba( 70, 70, 70, 1 ); /* border color of inline code */
|
||||
|
||||
--BROWSER-theme: dark; /* name of the theme for browser scrollbars of the main section */
|
||||
--MERMAID-theme: dark; /* name of the default Mermaid theme for this variant, can be overridden in config.toml */
|
||||
--OPENAPI-theme: dark; /* name of the default OpenAPI theme for this variant, can be overridden in config.toml */
|
||||
--OPENAPI-CODE-theme: obsidian; /* name of the default OpenAPI code theme for this variant, can be overridden in config.toml */
|
||||
--MERMAID-theme: dark; /* name of the default Mermaid theme for this variant, can be overridden in hugo.toml */
|
||||
--OPENAPI-theme: dark; /* name of the default OpenAPI theme for this variant, can be overridden in hugo.toml */
|
||||
--OPENAPI-CODE-theme: obsidian; /* name of the default OpenAPI code theme for this variant, can be overridden in hugo.toml */
|
||||
|
||||
--MENU-HOME-LINK-color: rgba( 64, 64, 64, 1 ); /* home button color if configured */
|
||||
--MENU-HOME-LINK-HOVER-color: rgba( 0, 0, 0, 1 ); /* hovered home button color if configured */
|
||||
|
|
|
|||
|
|
@ -17,9 +17,9 @@
|
|||
--CODE-INLINE-BORDER-color: rgba( 248, 232, 200, 1 ); /* border color of inline code */
|
||||
|
||||
--BROWSER-theme: light; /* name of the theme for browser scrollbars of the main section */
|
||||
--MERMAID-theme: default; /* name of the default Mermaid theme for this variant, can be overridden in config.toml */
|
||||
--OPENAPI-theme: light; /* name of the default OpenAPI theme for this variant, can be overridden in config.toml */
|
||||
--OPENAPI-CODE-theme: idea; /* name of the default OpenAPI code theme for this variant, can be overridden in config.toml */
|
||||
--MERMAID-theme: default; /* name of the default Mermaid theme for this variant, can be overridden in hugo.toml */
|
||||
--OPENAPI-theme: light; /* name of the default OpenAPI theme for this variant, can be overridden in hugo.toml */
|
||||
--OPENAPI-CODE-theme: idea; /* name of the default OpenAPI code theme for this variant, can be overridden in hugo.toml */
|
||||
|
||||
--MENU-HOME-LINK-color: rgba( 64, 64, 64, 1 ); /* home button color if configured */
|
||||
--MENU-HOME-LINK-HOVER-color: rgba( 0, 0, 0, 1 ); /* hovered home button color if configured */
|
||||
|
|
|
|||
|
|
@ -17,9 +17,9 @@
|
|||
--CODE-INLINE-BORDER-color: rgba( 71, 71, 71, 1 ); /* border color of inline code */
|
||||
|
||||
--BROWSER-theme: dark; /* name of the theme for browser scrollbars of the main section */
|
||||
--MERMAID-theme: dark; /* name of the default Mermaid theme for this variant, can be overridden in config.toml */
|
||||
--OPENAPI-theme: dark; /* name of the default OpenAPI theme for this variant, can be overridden in config.toml */
|
||||
--OPENAPI-CODE-theme: obsidian; /* name of the default OpenAPI code theme for this variant, can be overridden in config.toml */
|
||||
--MERMAID-theme: dark; /* name of the default Mermaid theme for this variant, can be overridden in hugo.toml */
|
||||
--OPENAPI-theme: dark; /* name of the default OpenAPI theme for this variant, can be overridden in hugo.toml */
|
||||
--OPENAPI-CODE-theme: obsidian; /* name of the default OpenAPI code theme for this variant, can be overridden in hugo.toml */
|
||||
|
||||
--MENU-BORDER-color: rgba( 71, 71, 71, 1 ); /* border color between menu and content */
|
||||
--MENU-TOPBAR-BORDER-color: rgba( 39, 39, 39, 1 ); /* separator color of vertical line between menu and topbar */
|
||||
|
|
|
|||
|
|
@ -17,9 +17,9 @@
|
|||
--CODE-INLINE-BORDER-color: rgba( 248, 232, 200, 1 ); /* border color of inline code */
|
||||
|
||||
--BROWSER-theme: light; /* name of the theme for browser scrollbars of the main section */
|
||||
--MERMAID-theme: default; /* name of the default Mermaid theme for this variant, can be overridden in config.toml */
|
||||
--OPENAPI-theme: light; /* name of the default OpenAPI theme for this variant, can be overridden in config.toml */
|
||||
--OPENAPI-CODE-theme: idea; /* name of the default OpenAPI code theme for this variant, can be overridden in config.toml */
|
||||
--MERMAID-theme: default; /* name of the default Mermaid theme for this variant, can be overridden in hugo.toml */
|
||||
--OPENAPI-theme: light; /* name of the default OpenAPI theme for this variant, can be overridden in hugo.toml */
|
||||
--OPENAPI-CODE-theme: idea; /* name of the default OpenAPI code theme for this variant, can be overridden in hugo.toml */
|
||||
|
||||
--MENU-BORDER-color: rgba( 210, 210, 210, 1 ); /* border color between menu and content */
|
||||
--MENU-TOPBAR-BORDER-color: rgba( 247, 247, 247, 1 ); /* border color of vertical line between menu and topbar */
|
||||
|
|
|
|||
|
|
@ -585,9 +585,9 @@ var variants = {
|
|||
{ name: 'CODE-INLINE-BORDER-color', group: 'inline code', default: '#fbf0cb', tooltip: 'border color of inline code', },
|
||||
|
||||
{ name: 'BROWSER-theme', group: '3rd party', default: 'light', tooltip: 'name of the theme for browser scrollbars of the main section', },
|
||||
{ name: 'MERMAID-theme', group: '3rd party', default: 'default', tooltip: 'name of the default Mermaid theme for this variant, can be overridden in config.toml', },
|
||||
{ name: 'OPENAPI-theme', group: '3rd party', default: 'light', tooltip: 'name of the default OpenAPI theme for this variant, can be overridden in config.toml', },
|
||||
{ name: 'OPENAPI-CODE-theme', group: '3rd party', default: 'obsidian', tooltip: 'name of the default OpenAPI code theme for this variant, can be overridden in config.toml', },
|
||||
{ name: 'MERMAID-theme', group: '3rd party', default: 'default', tooltip: 'name of the default Mermaid theme for this variant, can be overridden in hugo.toml', },
|
||||
{ name: 'OPENAPI-theme', group: '3rd party', default: 'light', tooltip: 'name of the default OpenAPI theme for this variant, can be overridden in hugo.toml', },
|
||||
{ name: 'OPENAPI-CODE-theme', group: '3rd party', default: 'obsidian', tooltip: 'name of the default OpenAPI code theme for this variant, can be overridden in hugo.toml', },
|
||||
|
||||
{ name: 'MENU-BORDER-color', group: 'header', default: 'transparent', tooltip: 'border color between menu and content', },
|
||||
{ name: 'MENU-TOPBAR-BORDER-color', group: 'header', fallback: 'MENU-HEADER-BG-color', tooltip: 'border color of vertical line between menu and topbar', },
|
||||
|
|
|
|||
Loading…
Reference in a new issue