| title | description | date | layout |
|---|---|---|---|
Navigation |
Help the user navigate your website using configurable navigation elements. |
2024-01-24 |
docs |
Hinode supports several types of navigation that utilize Bootstrap elements. The main navigation is positioned on the top of the screen and includes a search input element. An optional secondary navigation is available as sidebar. Next to these navigation items, pages may optionally include a breadcrumb to indicate the current page's location within the site's navigational hierarchy. Finally, pages may also include a table of contents element that is linked to the scroll position of the current page.
The basic configuration of the navigation elements is set in the navigation section of the site parameters. The following settings are supported:
{{< table >}}
| Setting | Default | Description |
|---|---|---|
| anchor | - | Flag indicating to display anchor links on hovering a heading. |
| logo | - | Address of the brand logo image, e.g. "/img/logo_embedded.svg". The vector image file is expected to be present in your local static/img folder. |
| color | - | [Theme color]({{< ref "colors" >}}) of the navigation bar. Set the style to set the correct contrast of the menu items. The navigation bar is transparent when no color is set, but is set to the body color when scrolling to enhance the contrast. |
| style | "light" | Style of the navigation bar, either "light" or "dark". It changes the colors of the menu items accordingly. |
| fixed | false | Flag indicating to keep the navigation bar fixed at the top of the screen. |
| overlay | false | {{</* release version="v0.23.0" short="true" size="sm" inline="true" */>}} Flag indicating to render the navigation bar as overlay on top of the page body. In this state, the navigation is transparent and the page body starts at the top of the viewport. The navigation becomes opaque when scrolling and is set to the specified theme color. |
| overlayMode | "dark" | {{</* release version="v0.23.0" short="true" size="sm" inline="true" */>}} Style of the navigation bar when overlay is set, either “light” or “dark”. |
| horizontal | false | {{</* release version="v0.21.0" short="true" size="sm" inline="true" */>}} Flag indicating the second level navigation should render horizontally. By default, the navbar uses regular dropdown menus instead. |
| offset | "3em" | Applies an {{</* link bs_navbar_placement >}}offset to main elements{{< /link */>}} when fixed is set to true. |
| size | "md" | Optional breakpoint of the navbar toggler, either "xs", "sm", "md" (default), "lg", or "xl". |
| search | true | Flag indicating to include a search input. |
| breadcrumb | false | Flag indicating to add breadcrumb navigation to the top of any single page. List pages are excluded. |
| toc | true | Flag indicating to enable table of contents globally. Individual pages can override this setting in the frontmatter using the value includeToc. |
| sidebar | true | Flag indicating to enable sidebar navigation globally. If set, a sidebar is displayed when applicable. |
| {{< /table >}} |
The below configuration shows the default configuration set in config/_default/params.toml.
{{< docs name="navigation" file="config/_default/params.toml" >}}
The main navigation uses {{< link hugo_menus >}}Hugo's menu system{{< /link >}} to generate a responsive navigation bar at the top of the page. The navigation bar uses a breakpoint to add a toggler for smaller screens. A language switcher is added automatically if your site supports multiple languages. The language switcher links to the currently translated page if available.
The navigation bar uses {{< link hugo_menus >}}Hugo's menu system{{< /link >}} to generate the menu items. The navigation supports nesting at one level deep. Hinode supports an additional parameter called alias. If set, the active menu item is linked to the specific menu entry instead of being derived from the target URL. The following example defines an example menu configuration called sample (the main configuration is called main).
{{< docs name="sample-navigation" file="./config/_default/menus/menus.en.toml" >}}
The example below illustrates the navigation bar based on the sample configuration defined in the previous paragraph. The About and About (no alias) menu entries illustrate the behavior of the alias parameter. The GitHub menu entry shows an icon to indicate it is an external link and opens in a new window.
{{< navbar path="guides" color="body-tertiary" size="sm" search="false" menus="alias" title="Sample" >}}
The main navigation supports versioning too. When configured, a drop-down menu containing the available versions is automatically added. See the [documentation configuration]({{< relref "documentation" >}}) for more details.
Hinode includes a navigation bar at the top of the screen by default. You can modify the configuration in the layouts/_default/baseof.html file. The navigation bar is also available as [shortcode]({{< ref "navbar" >}}).
The following variables are available to modify the styling of the horizontal navigation. You can override them in assets/scss/theme/_variables.scss.
{{< docs name="horizontal-nav" file="assets/scss/common/_variables.scss" >}}
Hinode supports optional sidebar navigation. It is intended to be used as companion to the main navigation and is typically used in content-heavy sections, such as documentation pages. On smaller screens, the sidebar is replaced with an {{< link bs_offcanvas >}}offcanvas element{{< /link >}}. In this case, the main navigation receives an additional toggler on the left of the screen.
{{< alert >}} New in v0.20.1 - Menu items now support an optional link argument. When defined, this link takes precedence over the link that is automatically derived from the menu. {{< /alert >}}
Inspired by Bootstrap's documentation site, Hinode uses a separate configuration file for the sidebar menus. A sidebar can be configured for each main section of the site. For example, the sidebar menu of the docs section is defined in data/docs.yml. The sidebar menu supports group items and single page items. You can optionally provide an internal or external link for the destination page (see the {{< link "docs/components/link" >}}link shortcode{{< /link >}} for its behavior). By default, Hinode derives the destination from the menu item. The below example defines a group section called Getting started with three siblings. A single page About is added next. The latter redirects to an external website.
- title: Getting started
pages:
- title: Introduction
- title: Commands
- title: Contribute
- title: About
link: https://example.comMenu items can be nested within each other. The below example defines three content pages at the relative path A/B/C. The navigation path should be similar to the slug of the individual pages.
- title: A
pages:
- title: B
pages:
- title: C
pages:
- title: First
- title: Second
- title: Third{{< release version="v0.15.0" >}}
{{< alert type="info" >}}
Release v0.15.0 of Hinode automatically detects the version of the current context. The configuration of the version attribute is no longer needed.
{{< /alert >}}
You can create versioned files for your menu data by adding a version suffix to the data file. For example, data/docs-1.0.yml contains the menu data for the docs menu of version 1.0. Hinode uses data/docs.yml as default sidebar navigation data when no versioned file is available. See the [documentation configuration]({{< relref "documentation" >}}) for additional options.
The file assets/scss/components/_sidebar.scss contains the styling of the sidebar. It refers to a button $btn-toggle that is defined in assets/scss/common/_icons.scss. It also defines the spacing to be added to the page's main content section when using a fixed navigation bar:
{{< docs name="sidebar" file="assets/scss/components/_sidebar.scss" >}}
Hinode supports optional breadcrumb navigation. The breadcrumb indicates the current page's location within the site's navigational hierarchy. It is automatically populated by Hugo. Enable the breadcrumb in the basic navigation configuration. If enabled, all single pages will add breadcrumb navigation to the top of the page.
When enabled, the breadcrumb looks like this:
{{< example lang="hugo" >}} {{</* breadcrumb path="breadcrumb" */>}} {{< /example >}}
The breadcrumb is also available as [shortcode]({{< ref "breadcrumb" >}}).
Single pages can optionally show an {{< link hugo_toc >}}table of contents{{< /link >}} on the right of the screen. The table of contents is automatically populated based on the headings within the page content (two levels deep). The table of contents is hidden if it has less than two items. On smaller screens, a drop-down menu is added to the top of the page. Enable the table of contents in the basic navigation configuration. If enabled, all single pages will show the element, unless disabled in the page's frontmatter.
The file assets/scss/components/_toc.scss defines the styling of the table of contents element. It adds spacing to align the element to the sidebar, amongst other styling:
{{< docs name="toc" file="assets/scss/components/_toc.scss" >}}