nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-11-27 09:43:06 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
hugo-theme-relearn/exampleSite/content/authoring/frontmatter/topbar/_index.en.md
Sören Weber 41cefeda69
docs: add categories taxonomy #567
2024-10-12 19:28:32 +02:00

3.6 KiB
Raw Blame History

+++ categories = ["howto"] description = "Configure the topbar" frontmatter = ["disableBreadcrumb", "disableNextPrev", "disableToc", "editURL"] options = ["disableBreadcrumb", "disableNextPrev", "disableToc", "editURL"] title = "Topbar" weight = 4 +++

This page is about how to configure the topbar using configuration options. If you want to add further buttons or functionality, see this section.

Your topbar contains the following elements. Some of them are configuarable:

  • {{% button style="transparent" icon="bars" %}}{{% /button %}} sidebar: opens the sidebar flyout if in mobile layout
  • {{% button style="transparent" icon="list-alt" %}}{{% /button %}} toc: opens the table of contents in an overlay
  • {{% button style="transparent" icon="empty" %}}{{% /button %}} breadcrumb: shows the clickable breadcrumbs
  • {{% button style="transparent" icon="pen" %}}{{% /button %}} edit: browses to the editable page if the editURL parameter is set
  • {{% button style="transparent" icon="print" %}}{{% /button %}} print: browses to the chapters printable page if print support was activated
  • {{% button style="transparent" icon="chevron-left" %}}{{% /button %}} prev: browses to the previous page if there is one
  • {{% button style="transparent" icon="chevron-right" %}}{{% /button %}} next: browses to the next page if there is one
  • {{% button style="transparent" icon="ellipsis-v" %}}{{% /button %}} more: opens the overlay if screen space is limited

Table of Contents

{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /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.

{{< multiconfig fm=true >}} disableToc = true {{< /multiconfig >}}

Breadcrumbs

{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} Set disableBreadcrumb=true to hide the breadcrumb in the topbar.

Further breadcrumbs settings can be found in the content configuration section.

{{< multiconfig fm=true >}} disableBreadcrumb = true {{< /multiconfig >}}

Edit Button

{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /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 front matter.

{{< multiconfig fm=true >}} editURL = 'https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}' {{< /multiconfig >}}

Arrow Navigation

{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} You can hide the previous/next buttons by setting disableNextPrev=true. If the buttons are hidden, also the keyboard shortcuts are disabled.

{{< multiconfig fm=true >}} disableNextPrev = true {{< /multiconfig >}}