Last updated

navbar

The navbar appears across the top of the website. You can configure the links and groups of links that appear on the navbar of your site, or hide the navbar altogether. The navbar is a good location for top-level category or frequently-used links.

Options

OptionTypeDescription
itemsItem | GroupList of items in the Navbar.

hide

boolean

Specifies if the navbar should be hidden. Default: false.

The navbar.hide option also supports page-level configuration using front matter.

Group object

OptionTypeDescription
groupstringREQUIRED. Name of the group.
groupTranslationKeystringSpecifies the group name key used for localization.
itemsItemREQUIRED. List of items. The navbar for the default theme may only have one level of depth to groups.
linkedSidebars[string]Array of relative paths to sidebar files. This option will add the navbar item to a sidebar's breadcrumbs. Only effective for top-level navbar items.

Item object

OptionTypeDescription
pagestringCONDITIONALLY REQUIRED. Path to the file which represents the page to link to. Mutually exclusive with the href option. If you use the page option, and do not include the label option, the text for the link on the sidebar will match the level 1 heading of the page.
hrefstringCONDITIONALLY REQUIRED. URL to link to. Mutually exclusive with the page option. If you use the href option, and do not include the label option, the text for the link on the sidebar will match the href option's value.
labelstringLink text displayed for the item.
labelTranslationKeystringLink text key for the item used for internationalization.
iconstringPath to the icon file.
externalbooleanOpen link in new browser tab. Default is false.
linkedSidebars[string]Array of relative paths to sidebar files. This option will add navbar item to sidebar's breadcrumbs. Only effective for top-level navbar items.

Examples

Simple menu

The following is an example configuration for a simple flat navbar.

navbar:
  items:
    - page: introduction.md
    - page: howto.md
      label: How To
    - page: api-definition.yaml
    - label: Other docs
      href: https://redoc.ly/docs/developer-portal/introduction/
      external: true

The following is a screenshot of that navbar.

1 level Navbar

The following is an example of a dropdown menu in a navbar config.

navbar:
  items:
    - group: Products
      items:
        - page: reference-docs.tsx
          label: Reference Docs
        - page: developer-portal.tsx
          label: Developer Portal
        - page: workflows.md
          label: Workflows
        - separator: Free API Tools
        - page: redoc.md
          label: Redoc
        - page: redoc-vs-redocly.md
          label: Redoc vs Redocly
        - page: redocly-cli.md
          label: Redocly CLI
    - label: Docs
      page: docs.md
    - label: Pricing
      page: pricing.md
    - label: Enterprise
      page: Enterprise.md

The following is the visual screenshot of the navbar. Dropdown menu

navbar:
  items:
    - page: introduction.md
      linkedSidebars:
        - sidebars.yaml
    - page: howto.md
      label: How To

Resources

 
Next page