mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2025-01-18 10:50:24 +00:00
docs: marking config options #567
This commit is contained in:
Sören Weber
parent
d8c353b1a5
commit
7b03f47856
15 changed files with 91 additions and 73 deletions
|
|
@ -11,15 +11,15 @@ The Relearn theme ships with a set of predefined color variants. You can use the
|
|||
|
||||
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}
|
||||
## Change the Variant
|
||||
|
||||
{{% notice tip %}}
|
||||
The theme provides an advanced configuration mode, combining the functionality for multiple variants with the possibility of adjusting to your OS settings and syntax highlighting and even more!
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} You can change the variant by setting the `themeVariant` option.
|
||||
|
||||
Although all options documented here are still working, the advanced configuration options are the recommended way to configure your color variants. [See below](#theme-variant-advanced).
|
||||
{{% /notice %}}
|
||||
The theme provides a recommended [advanced configuration mode](#theme-variant-advanced), combining the functionality for [multiple variants](#multiple-variants) with the possibility of [adjusting to your OS settings](#adjust-to-os-settings) and syntax highlighting and even more!
|
||||
|
||||
### Single Variant
|
||||
### Simple {#theme-variant}
|
||||
|
||||
#### Single Variant
|
||||
|
||||
Set the `themeVariant` value to the name of your theme CSS file. That's it! Your site will be displayed in this variant only.
|
||||
|
||||
|
|
@ -34,7 +34,7 @@ In the above example, the path of your theme file must be `assets/css/theme-rele
|
|||
|
||||
If you want to make changes to a shipped color variant, [see your choices below](#modify-shipped-variants).
|
||||
|
||||
### Multiple Variants
|
||||
#### Multiple Variants
|
||||
|
||||
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.
|
||||
|
||||
|
|
@ -43,9 +43,9 @@ You can also set multiple variants. In this case, the first variant is the defau
|
|||
themeVariant = [ "relearn-light", "relearn-dark" ]
|
||||
{{< /multiconfig >}}
|
||||
|
||||
### Adjust to OS Settings
|
||||
#### Adjust to OS Settings
|
||||
|
||||
You can also cause the site to adjust to your OS settings for light/dark mode. Just set the `params.themeVariant` to `auto` to become an auto mode variant. That's it.
|
||||
You can also cause the site to adjust to your OS settings for light/dark mode. Just set the `themeVariant` to `auto` to become an auto mode variant. That's it.
|
||||
|
||||
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.
|
||||
|
||||
|
|
@ -54,18 +54,18 @@ You can use the `auto` value with the single or multiple variants option. If you
|
|||
themeVariant = [ "auto", "red" ]
|
||||
{{< /multiconfig >}}
|
||||
|
||||
If you don't configure anything else, the theme will default to use `relearn-light` for light mode and `relearn-dark` for dark mode. These defaults are overwritten by the first two non-auto options of your `params.themeVariant` option if present.
|
||||
If you don't configure anything else, the theme will default to use `relearn-light` for light mode and `relearn-dark` for dark mode. These defaults are overwritten by the first two non-auto options of your `themeVariant` option if present.
|
||||
|
||||
In the above example, you would end with `red` for light mode and the default of `relearn-dark` for dark mode.
|
||||
|
||||
If you don't like that behavior, you can explicitly set `params.themeVariantAuto`. The first entry in the array is the color variant for light mode, the second for dark mode.
|
||||
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.
|
||||
|
||||
{{< multiconfig file=hugo >}}
|
||||
[params]
|
||||
themeVariantAuto = [ "learn", "neon" ]
|
||||
{{< /multiconfig >}}
|
||||
|
||||
## Change the Variant (Advanced) {#theme-variant-advanced}
|
||||
### Advanced {#theme-variant-advanced}
|
||||
|
||||
The theme offers an advanced way to configure theme variants and all of the aspects above inside of a single configuration item. This comes with some features previously unsupported.
|
||||
|
||||
|
|
@ -90,7 +90,7 @@ you now write it that way:
|
|||
|
||||
The `identifier` option is mandatory and equivalent to the string in the first example. Further options can be configured, see the table below.
|
||||
|
||||
### Parameter
|
||||
#### Parameter
|
||||
|
||||
| Name | Default | Notes |
|
||||
|-----------------------|-----------------|-------------|
|
||||
|
|
@ -98,7 +98,7 @@ The `identifier` option is mandatory and equivalent to the string in the first e
|
|||
| name | see notes | The name to be displayed in the variant selector. If not set, the identifier is used in a human readable form. |
|
||||
| auto | _<empty>_ | If set, the variant is treated as an [auto mode variant](#adjust-to-os-settings). It has the same behavior as the `themeVariantAuto` option. The first entry in the array is the color variant for light mode, the second for dark mode. Defining auto mode variants with the advanced options has the benefit that you can now have multiple auto mode variants instead of just one with the simple options. |
|
||||
|
||||
### Example Configuration of This Site
|
||||
#### Example Configuration of This Site
|
||||
|
||||
{{< multiconfig file=hugo >}}
|
||||
themeVariant = [
|
||||
|
|
@ -185,7 +185,7 @@ The file must be written to `assets/css/chroma-<NAME>.css`. To use it with your
|
|||
|
||||
## Change 3rd-Party Libraries Theming
|
||||
|
||||
Some of the shipped shortcodes are using 3rd-party libraries. See the individual shortcode documentation on how to do this:
|
||||
Some of the shipped shortcodes are using 3rd-party libraries. See the individual shortcode documentation on how to change their theming
|
||||
|
||||
- [`mermaid` shortcode](shortcodes/mermaid#setting-a-specific-mermaid-theme)
|
||||
- [`openapi` shortcode](shortcodes/openapi#setting-a-specific-swagger-ui-theme)
|
||||
|
|
|
|||
|
|
@ -19,11 +19,11 @@ 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 `assets/css` directory. Afterwards you have to adjust the `params.themeVariant` option in your `hugo.toml` to your chosen file name.
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} Once you are satisfied, you can download the new variants file and copy it into your site's `assets/css` directory. Afterwards you have to adjust the `themeVariant` option 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 `params.themeVariant='my-custom-variant'` to use it.
|
||||
Eg. if your new variants file is named `theme-my-custom-variant.css`, you have to set `themeVariant='my-custom-variant'` to use it.
|
||||
|
||||
See the docs for [further configuration options](configuration/appearance/branding)
|
||||
See the docs for [further configuration options](configuration/appearance/branding).
|
||||
{{% /expand %}}
|
||||
|
||||
{{% button style="secondary" icon="download" href="javascript:window.variants&&variants.getStylesheet();this.blur();" %}}Download variant{{% /button %}}
|
||||
|
|
|
|||
|
|
@ -9,19 +9,19 @@ This page is about how to configure supported options for the topbar. If you wan
|
|||
|
||||
## Table of Contents
|
||||
|
||||
Set `params.disableToc=true` to hide the TOC button on all pages. If the button is hidden, also the keyboard shortcut is disabled. This can be overridden in a page's front matter.
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} Set `disableToc=true` to hide the TOC button on all pages. If the button is hidden, also the keyboard shortcut is disabled. This can be overridden in a page's front matter.
|
||||
|
||||
## Breadcrumbs
|
||||
|
||||
Set `params.disableBreadcrumb=true` to hide the breadcrumb in the topbar.
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} Set `disableBreadcrumb=true` to hide the breadcrumb in the topbar.
|
||||
|
||||
Further, you can override the breadcrumb separator by using `params.breadcrumbSeparator="/"`. This separator will also be used in the breadcrumbs of the search results and taxonomy pages.
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} Further, you can override the breadcrumb separator by using `breadcrumbSeparator="/"`. This separator will also be used in the breadcrumbs of the search results and taxonomy pages.
|
||||
|
||||
Set `params.disableRootBreadcrumb=true` to remove the root breadcrumb which often feels redundant. This will also apply to the breadcrumbs of the search results and taxonomy pages.
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} `disableRootBreadcrumb=true` to remove the root breadcrumb which often feels redundant. This will also apply to the breadcrumbs of the search results and taxonomy pages.
|
||||
|
||||
## Edit Button
|
||||
|
||||
If `editURL` is set to a URL, an edit button will be shown in the topbar. If the button is hidden, also the keyboard shortcut is disabled.
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} If `editURL` is set to a URL, an edit button will be shown in the topbar. If the button is hidden, also the keyboard shortcut is disabled.
|
||||
|
||||
The value can contain the macro `${FilePath}` which will be replaced by the file path of your displayed page. If no `${FilePath}` is given in the value, the value is treated as if the `${FilePath}` was appended at the end of the value. This can be overridden in the pages frontmatter.
|
||||
|
||||
|
|
@ -48,4 +48,4 @@ Nevertheless, if you're unhappy with the resulting URLs you can manually redefin
|
|||
|
||||
## Arrow Navigation
|
||||
|
||||
You can hide the previous/next buttons by setting `params.disableNextPrev=true`. If the buttons are hidden, also the keyboard shortcuts are disabled.
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} You can hide the previous/next buttons by setting `disableNextPrev=true`. If the buttons are hidden, also the keyboard shortcuts are disabled.
|
||||
|
|
|
|||
|
|
@ -7,18 +7,12 @@ weight = 3
|
|||
|
||||
Each heading may have an anchor link that is displayed when the heading is hovered.
|
||||
|
||||
The behavior what should happen if the anchor icon is clicked is configurable in your `hugo.toml`. By default all options are activated. If you deactivate all options, no link will be shown on hover.
|
||||
|
||||
{{< multiconfig file=hugo >}}
|
||||
[params]
|
||||
disableAnchorCopy = false
|
||||
disableAnchorScrolling = false
|
||||
{{< /multiconfig >}}
|
||||
The behavior what should happen if the anchor icon is clicked is configurable in your `hugo.toml`. By default all of the following options are activated. If you deactivate all options, no anchor icon will be shown on hover.
|
||||
|
||||
## Copy Anchor Links to Clipboard
|
||||
|
||||
If you set `params.disableAnchorCopy=true`, no anchor link will be copied to the clipboard when the anchor icon is pressed.
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} If you set `disableAnchorCopy=true`, no anchor link will be copied to the clipboard when the anchor icon is pressed.
|
||||
|
||||
## Scroll to Heading
|
||||
|
||||
If you set `params.disableAnchorScrolling=true`, the page will not scroll to the beginning of the heading when the anchor icon is clicked.
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} If you set `disableAnchorScrolling=true`, the page will not scroll to the beginning of the heading when the anchor icon is clicked.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
+++
|
||||
description = "Learn about the hiddes pages feature"
|
||||
frontmatter = ["hidden"]
|
||||
options = ["disableSearchHiddenPages", "disableSeoHiddenPages", "disableTagHiddenPages"]
|
||||
title = "Hidden Pages"
|
||||
weight = 5
|
||||
|
|
@ -7,7 +8,7 @@ weight = 5
|
|||
|
||||
The theme provides the concept of hidden pages.
|
||||
|
||||
While Hugo has the `draft` option to not create a page at all, a hidden page is created but not shown in the navigation. Just set `hidden=true` in your pages front matter. This can be useful if you want to have a page that is only accessible via a link.
|
||||
{{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} While Hugo has the `draft` option to not create a page at all, a hidden page is created but not shown in the navigation. Just set `hidden=true` in your pages front matter. This can be useful if you want to have a page that is only accessible via a link.
|
||||
|
||||
If you access a hidden page via its URL, it will be revealed in the navigation menu.
|
||||
|
||||
|
|
@ -17,12 +18,12 @@ By default, a hidden page is only hidden from a human user of your site. Crawler
|
|||
|
||||
## Hide from Search
|
||||
|
||||
To hide hidden pages from search results of the search popup and dedicated search page, set `params.disableSearchHiddenPages=true`.
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} To hide hidden pages from search results of the search popup and dedicated search page, set `disableSearchHiddenPages=true`.
|
||||
|
||||
## Hide from Crawlers
|
||||
|
||||
To hide hidden pages from crawlers by removing links from the sitemap and rss feed, set `params.disableSeoHiddenPages=true`.
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} To hide hidden pages from crawlers by removing links from the sitemap and rss feed, set `disableSeoHiddenPages=true`.
|
||||
|
||||
## Hide from Taxonomies
|
||||
|
||||
To hide hidden pages from showing up on the taxonomy and term pages, set `params.disableTagHiddenPages=true`. If this reduces term counters to zero, an empty but unlinked term page will be created anyhow.
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} To hide hidden pages from showing up on the taxonomy and term pages, set `disableTagHiddenPages=true`. If this reduces term counters to zero, an empty but unlinked term page will be created anyhow.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
+++
|
||||
description = "Add further code to your site"
|
||||
options = ["relearn.dependencies"]
|
||||
title = "Extending HTML"
|
||||
weight = 2
|
||||
+++
|
||||
|
|
@ -26,7 +27,7 @@ You can you use this mechanism in your own shortcodes. Say you want to add a sho
|
|||
{{- .Page.Store.Set "hasMyShortcode" true }}
|
||||
````
|
||||
|
||||
1. Add the following snippet to your `hugo.toml`
|
||||
1. {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} Add the following snippet to your `hugo.toml`
|
||||
|
||||
{{< multiconfig file=hugo >}}
|
||||
[params.relearn.dependencies]
|
||||
|
|
@ -48,7 +49,7 @@ 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 `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.
|
||||
- the key on `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.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,7 @@
|
|||
+++
|
||||
description = "How to extend image effects"
|
||||
frontmatter = ["imageEffects"]
|
||||
options = ["imageEffects"]
|
||||
title = "Custom Image Effects"
|
||||
weight = 3
|
||||
+++
|
||||
|
|
@ -13,13 +15,11 @@ The theme supports non-standard [image effects](content/markdown#image-effects).
|
|||
| lightbox | The image will be clickable to show it enlarged |
|
||||
| shadow | Draws a shadow around the image to make it appear hovered/glowing |
|
||||
|
||||
As [described](content/markdown#image-effects), you can add this to the URL query parameter, but this may be cumbersome to be done consistently for the whole page.
|
||||
As [described](content/markdown#image-effects), you can add this to the URL query parameter, but this may be cumbersome to be done consistently for the whole page. Instead, you can configure the defaults in your `hugo.toml` as well as overriding these default in the pages frontmatter.
|
||||
|
||||
Instead, you can configure the defaults in your `hugo.toml` as well as overriding these default in the pages frontmatter.
|
||||
Explicitly set URL query parameter will override the defaults in effect for a page or your site.
|
||||
|
||||
Explicitly set URL query parameter will override the defaults in effect for a page.
|
||||
|
||||
Without any settings in your `hugo.toml` this defaults to
|
||||
Without any settings in your `hugo.toml` `imageEffects` defaults to
|
||||
|
||||
{{< multiconfig file=hugo >}}
|
||||
[params]
|
||||
|
|
@ -30,7 +30,7 @@ Without any settings in your `hugo.toml` this defaults to
|
|||
shadow = false
|
||||
{{< /multiconfig >}}
|
||||
|
||||
This can be overridden in a pages frontmatter by eg.
|
||||
{{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} This can be overridden in a pages front matter by eg.
|
||||
|
||||
{{< multiconfig fm=true >}}
|
||||
[imageEffects]
|
||||
|
|
@ -62,8 +62,18 @@ 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 `hugo.toml` or pages frontmatter.
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} As you can see in the above example, the `bg-white` parameter is not initially supported in the themes default settings. The theme allows you to define arbitrary parameter by just adding them to the URL query parameter or set them in your page's frontmatter or `hugo.toml`.
|
||||
|
||||
{{< multiconfig file=hugo >}}
|
||||
[params]
|
||||
[params.imageEffects]
|
||||
bg-white = true
|
||||
border = false
|
||||
lazy = true
|
||||
lightbox = true
|
||||
shadow = false
|
||||
{{< /multiconfig >}}
|
||||
|
||||
{{% 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 `hugo.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 page's frontmatter or `hugo.toml` .
|
||||
{{% /notice %}}
|
||||
|
|
|
|||
|
|
@ -7,9 +7,16 @@ weight = 6
|
|||
|
||||
You can set configuration options in your `hugo.toml`.
|
||||
|
||||
A configurable option is marked with a {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} badge throughout the documentation.
|
||||
On top of [Hugo's configuration options](https://gohugo.io/getting-started/configuration/#all-configuration-settings), you can use the additional theme settings listed below.
|
||||
|
||||
On top of [Hugo's configuration options](https://gohugo.io/getting-started/configuration/#all-configuration-settings), you can use the following settings unique to the theme.
|
||||
A configuration option provided by the theme is marked with a {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} badge throughout the documentation.
|
||||
|
||||
You set each theme configuration option in the `params` section of your `hugo.toml`. For example, setting `math`
|
||||
|
||||
{{< multiconfig file=hugo >}}
|
||||
[params]
|
||||
math = true
|
||||
{{< /multiconfig >}}
|
||||
|
||||
## Index
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ weight = 2
|
|||
|
||||
## Home Button Configuration
|
||||
|
||||
If `params.disableLandingPageButton=true`, the Home button will be hidden on the left menu.
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} If `disableLandingPageButton=true`, the Home button will be hidden on the left menu.
|
||||
|
||||
If you display the Home button, it is an alternative for clicking on the logo. To edit its logo or text, you will have to configure the `landingPageName` for the defined languages
|
||||
|
||||
|
|
@ -34,7 +34,7 @@ The home button is going to look like this:
|
|||
|
||||
## History
|
||||
|
||||
Set `params.showVisitedLinks=true` to show checkmarks for visited pages of the main menu. This also causes the display of the `Clear History` entry in the lower part of the menu to remove all checkmarks. The checkmarks will also been removed if you regenerate your site as the used ids are not stable.
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} Set `showVisitedLinks=true` to show checkmarks for visited pages of the main menu. This also causes the display of the `Clear History` entry in the lower part of the menu to remove all checkmarks. The checkmarks will also been removed if you regenerate your site as the used ids are not stable.
|
||||
|
||||
## Footer
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
+++
|
||||
description = "Default behavior of the navigation menu"
|
||||
options = ["alwaysopen", "ordersectionsby"]
|
||||
options = ["alwaysopen", "collapsibleMenu", "ordersectionsby"]
|
||||
title = "Navigation Menu"
|
||||
weight = 4
|
||||
+++
|
||||
|
|
@ -11,7 +11,7 @@ You can define certain settings globally in your `hugo.toml`. These are inherite
|
|||
|
||||
## Expand State of Nested Sections
|
||||
|
||||
Use `params.alwaysopen` to set the initial expand state of submenus. This controls whether submenus will be expanded (`true`), or collapsed (`false`) in the menu. If not set, the first menu level is set to false, all others levels are set to true.
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} Use `alwaysopen` to set the initial expand state of submenus. This controls whether submenus will be expanded (`true`), or collapsed (`false`) in the menu. If not set, the first menu level is set to false, all others levels are set to true.
|
||||
|
||||
This can be overridden individually for each page in its front matter.
|
||||
|
||||
|
|
@ -19,7 +19,7 @@ If the _displayed_ page has submenus, they will always been displayed expanded r
|
|||
|
||||
## Expander for Nested Sections
|
||||
|
||||
Set `params.collapsibleMenu=true` to show an expander for submenus. If set to `true`, submenus in the sidebar will be displayed as collapsible trees and a clickable expander is set in front of those entries.
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} Set `collapsibleMenu=true` to show an expander for submenus. If set to `true`, submenus in the sidebar will be displayed as collapsible trees and a clickable expander is set in front of those entries.
|
||||
|
||||
> [!WARNING]
|
||||
> Setting this option to `true` may cause your build to significantly slow down and degrade built performance, depending on your machine and the amount of pages.
|
||||
|
|
@ -31,6 +31,6 @@ Set `params.collapsibleMenu=true` to show an expander for submenus. If set to `t
|
|||
|
||||
## Default Sort By
|
||||
|
||||
Set `params.ordersectionsby` to set the sorting criterium of navigation menus. Defaults to `weight`. Menus can be ordered by `weight`, `title`, `linktitle`, `modifieddate`, `expirydate`, `publishdate`, `date`, `length` or `default` (adhering to Hugo's default sort order).
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} Set `ordersectionsby` to set the sorting criterium of navigation menus. Defaults to `weight`. Menus can be ordered by `weight`, `title`, `linktitle`, `modifieddate`, `expirydate`, `publishdate`, `date`, `length` or `default` (adhering to Hugo's default sort order).
|
||||
|
||||
This can be overridden individually for each page in its front matter.
|
||||
|
|
|
|||
|
|
@ -15,16 +15,16 @@ The theme comes with three levels of search, all provided through the search for
|
|||
|
||||
Each level depends on the previous level to be enabled, eg. the dedicated search page is only available, if you have search popup and in-page search enabled. If no search level is configured, the search form will not be displayed.
|
||||
|
||||
By default all three levels are enabled. You can disable each level by the following settings in your `hugo.toml`:
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} By default all three levels are enabled. You can disable each level by the following settings in your `hugo.toml`:
|
||||
|
||||
- in-page search: `params.disableSearch=true`
|
||||
- search popup: `params.disableSearchIndex=true`
|
||||
- dedicated search page: `params.disableSearchPage=true`
|
||||
- in-page search: `disableSearch=true`
|
||||
- search popup: `disableSearchIndex=true`
|
||||
- dedicated search page: `disableSearchPage=true`
|
||||
|
||||
By default the following files will be created, relative to each languages home page but can be overwritten:
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} By default the following files will be created, relative to each languages home page but can be overwritten:
|
||||
|
||||
- search popup: `searchindex.js`, configured by `params.searchIndexURL`
|
||||
- dedicated search page: `search/index.html`, configured by `params.searchPageURL`
|
||||
- search popup: `searchindex.js`, configured by `searchIndexURL`
|
||||
- dedicated search page: `search/index.html`, configured by `searchPageURL`
|
||||
|
||||
{{% notice note %}}
|
||||
You only need to reconfigure the file / page URLs if you have own content at those URLs in your project. Eg. this can happen if you set `uglyURLs=true` in your `hugo.toml` and defining a Markdown file `content/search.md`.
|
||||
|
|
@ -48,7 +48,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 `hugo.toml` to broaden search.
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} 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 set those languages in `additionalContentLanguage` to broaden the search.
|
||||
|
||||
{{< multiconfig file=hugo >}}
|
||||
[params]
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ Be sure to use the `pageRef` property instead of `url` for all links internal to
|
|||
|
||||
## Title
|
||||
|
||||
By default, the shortcut menu is preceded by a title ("_More_" in the english translation). This title can be disabled by setting `params.disableShortcutsTitle=true`. However, if you want to keep the title but change its value, it can be overridden by changing your local i18n translation string configuration.
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} By default, the shortcut menu is preceded by a title ("_More_" in the english translation). This title can be disabled by setting `disableShortcutsTitle=true`. However, if you want to keep the title but change its value, it can be overridden by changing your local i18n translation string configuration.
|
||||
|
||||
For example, in your local `i18n/en.toml` file, add the following content
|
||||
|
||||
|
|
@ -134,7 +134,7 @@ If you have shortcuts to pages inside of your project and you don't want them to
|
|||
|
||||
1. Make the page file for the shortcut a [headless branch bundle](https://gohugo.io/content-management/page-bundles/#headless-bundle) (contained in its own subdirectory and called `_index.md`) and add the following frontmatter configuration to the file (see exampleSite's `content/showcase/_index.en.md`). This causes its content to **not** be contained in the sitemap.
|
||||
|
||||
{{< multiconfig fm=true >}}
|
||||
{{< multiconfig fm=true file="content/showcase/_index.en.md" >}}
|
||||
title = "Showcase"
|
||||
[_build]
|
||||
render = "always"
|
||||
|
|
@ -144,7 +144,7 @@ If you have shortcuts to pages inside of your project and you don't want them to
|
|||
|
||||
2. Store the page file for the shortcut below a parent headless branch bundle and add the following frontmatter to he **parent** (see exampleSite's `content/more/_index.en.md`). **Don't give this page a `title`** as this will cause it to be shown in the breadcrumbs - a thing you most likely don't want.
|
||||
|
||||
{{< multiconfig fm=true >}}
|
||||
{{< multiconfig fm=true file="content/more/_index.en.md" >}}
|
||||
[_build]
|
||||
render = "never"
|
||||
list = "never"
|
||||
|
|
@ -153,6 +153,6 @@ If you have shortcuts to pages inside of your project and you don't want them to
|
|||
|
||||
In this case, the file itself can be a branch bundle, leaf bundle or simple page (see exampleSite's `content/more/credits.en.md`). This causes its content to be contained in the sitemap.
|
||||
|
||||
{{< multiconfig fm=true >}}
|
||||
{{< multiconfig fm=true file="content/more/credits_index.en.md" >}}
|
||||
title = "Credits"
|
||||
{{< /multiconfig >}}
|
||||
|
|
|
|||
|
|
@ -51,7 +51,7 @@ Sublemental pages (like `sitemap.xml`, `rss.xml`) and generated social media lin
|
|||
|
||||
## URL Management
|
||||
|
||||
If you are using `uglyURLs=false` (Hugo's default), the theme will append an additional `index.html` to all page links to make your site be servable from the file system. If you don't care about the file system and only serve your page via a web server you can generate the links without this:
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} If you are using `uglyURLs=false` (Hugo's default), the theme will append an additional `index.html` to all page links to make your site be servable from the file system. If you don't care about the file system and only serve your page via a web server you can generate the links without this by setting `disableExplicitIndexURLs=true`.
|
||||
|
||||
{{< multiconfig file=hugo >}}
|
||||
[params]
|
||||
|
|
|
|||
|
|
@ -83,9 +83,9 @@ You may want to take a look into [search configuration](configuration/sidebar/se
|
|||
|
||||
## Disable Language Switching
|
||||
|
||||
Switching the language in the browser is a great feature, but for some reasons you may want to disable it.
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} Switching the language in the browser is a great feature, but for some reasons you may want to disable it.
|
||||
|
||||
Just set `params.disableLanguageSwitchingButton=true` in your `hugo.toml`
|
||||
Just set `disableLanguageSwitchingButton=true` in your `hugo.toml`
|
||||
|
||||
{{< multiconfig file=hugo >}}
|
||||
[params]
|
||||
|
|
|
|||
|
|
@ -4,12 +4,17 @@ title = "Front Matter Reference"
|
|||
weight = 6
|
||||
+++
|
||||
|
||||
|
||||
Each page in Hugo **has to define** front matter.
|
||||
|
||||
A configurable front matter is marked with a {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} badge throughout the documentation.
|
||||
On top of [Hugo's front matter](https://gohugo.io/content-management/front-matter/#fields), you can use the additional theme settings listed below.
|
||||
|
||||
On top of [Hugo's front matter](https://gohugo.io/content-management/front-matter/#fields), you can use the following settings unique to the theme.
|
||||
A front matter provided by the theme is marked with a {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} badge throughout the documentation.
|
||||
|
||||
You set each theme front matter directly in the root of your page's front matter. For example, setting `math`
|
||||
|
||||
{{< multiconfig fm=true >}}
|
||||
math = true
|
||||
{{< /multiconfig >}}
|
||||
|
||||
## Index
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue