The navbar of your website
Navbar fragment can show a logo/image, a menu with support for external links and a special icon link useful for linking to Github or Gitlab.
Note: Search doesn’t look very good in this page because there are two navbars in the page which is not expected. Please use search in other pages.
+++
fragment = "nav"
#disabled = true
date = "2018-05-17"
weight = 110
background = "secondary"
search = true
#sticky = true # Default is false
[breadcrumb]
display = true # Default value is false
#level = 0 # Default is 1
background = "light"
# Branding options
[asset]
image = "logo.svg"
text = "Syna"
[repo_button]
url = "https://github.com/okkur/syna"
text = "Star" # default: "Star"
icon = "fab fa-github" # defaults: "fab fa-github"
+++
Use one instance of this fragment per page. Running more might lead to unexpected issues.
.Site.Menus.main
Note: Menus displayed in the nav fragment can be nested, in which case the nested menus are displayed in a dropdown. Please see “nesting” section of Menus documentation in Hugo documentation.
# config.toml
[[menu.main]]
url = "/about"
name = "About"
weight = 10
identifier = "about"
[[menu.main]]
url = "/about/team"
name = "Our team"
weight = 10
parent = "about"
[[menu.main]]
url = "/about/office"
name = "Our office"
weight = 20
parent = "about"
type: boolean
default: false
If set to true, search is enabled within the navbar.
Note: The additional input field used for search will alter the menu layout.
type: boolean
default: false
If set to true, navbar will stick to the top of the screen whenever page scrolls past it.
type: array of objects
Menu like objects that are used to add menus before and after the main menu.
type: string
type: string
type: object
If object is set, breadcrumbs will be shown under the navbar.
type: boolean
default: true
type: number
default: 1
Define the section level the breadcrumb will start being shown.
The default value 1 would lead to the following being defined:
content/_index # level 0, not shown
content/blog/_index # level 1, shown
content/blog/article-1 # level 2, shown
type: string
recommended: primary, secondary, white, light, dark
accepted values: primary, secondary, white, light, dark, warning, success, danger, info, transparent
type: asset object
Asset will be shown as a clickable logo directing to the main page.
type: object
Enable a button on the top right navbar. Usually used to link to your repository such as Github or Gitlab.
The icon can be customized via repo_button.icon.
type: string
type: string
default: star
type: string
default: fab fa-github
Global variables are documented as well and have been omitted from this page.