Close
Close full mode
logoBooGi

Header

Git RepositoryEdit on Github
Last update: 4 days ago by Mateusz FilipowiczReading time: 2 min

Metadata base configuration can be set in config.yaml under header key.

PropertyDescriptionDefault value
header.enabledSet to true to enable (show) header.true
header.logoURL (relative or absolute) to logo. Example: /assets/logo.png
header.logoLinkURL to page showed when clicked on logo./
header.helpUrlURL to help page. When set, help icon will be visible in header.
header.linksList of links visible in header.
header.links[].textText of a header link.
header.links[].linkURL associated with header link.
header.links[].externalSet to true if link should be open in a separate browser tab.

Other configuration, that has impact on header look are:

  • search
  • dark / light mode

Full example:

header:
enabled: true
logo: "/assets/mylogo.png"
logoLink: "/"
helpUrl: "https://somehelp.mycompany.com"
links:
- text: BooGi
link: https://github.com/filipowm/boogi
external: true
- text: Another Link
link: /somethinghere
Previous
Progressive Web App
Next
Sidebar