Top Navigation Bar

AI Tools

The top navigation bar can be customised in multiple ways:

By default, the top navigation hosts a list of tabs. Starting with the Home tab which goes to the landing page, and then a tab for every documentation section and API reference.

The navigation structure can be further customised to feature navigation groups; a way for multiple documentation sections and API references to be grouped together under a dropdown.

To use navigation groups, first they need to be created. Then, documentation sections and API references can be assigned to navigation groups.

To create a navigation group:

  1. Open Project Settings → ContentNavigation Groups.

  2. Click Create navigation group.

  3. Give it a title and click Create.

You can reorder the navigation groups as needed here.

Now to assign a documentation section or an API reference to the navigation group:

  1. Open Manage Sections (section menu → settings cog).

  2. Select the documentation or API reference.

  3. Next to Navigation Group, assign a navigation group.

Info

If a documentation section or an API reference is not assigned to a navigation group, it will show up at the end of the tab list. If you wish for the documentation section or API reference to show up in a different order, create a navigation group and assign the documentation section or API reference to it. If a navigation group only contains one documentation section or API reference, it will show as a link tab, not as a dropdown.

The logo, and four top navigation links can be setup for external linking to another website, or internal linking inside the documentation. To setup the navigation links:

  1. Open Project Settings → Customisation.

  2. In the Top navigation links card, type the title and link for each of the four slots.

  3. Use the Open links in new tab toggle to choose whether links open in a new tab.

  4. Click Save changes in the top menu.

The last two links only show in documentations that have wide layout.

Go Home

Setting the link to / goes to the landing page, or the default page if no landing page is setup.

Sticky Top Navigation Bar

To set the top navigation bar to stick to the top when page is scrolled:

  1. Open Project Settings → Customisation.

  2. Check Is top navigation bar sticky?.

  3. Click Save changes in the top menu.


  Last updated
customisation