Top Navigation Bar

The top navigation bar can be customised in multiple ways:

• Logo
• Bar colour (brand colour) and navigation links colour
• Links
• Stickiness
• Navigation Structure

Navigation Structure

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. Click on Project settings in the sidebar.
2. Under Navigation Groups, 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. From the sidebar, choose Documentation or API Reference.
2. Open the settings by clicking on the settings icon.
3. Next to Navigation Group, assign a navigation group.

Adding Links / Home Button

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 navigations links:

1. Hover over the top navigation and click on Edit Navigation in the top left corner.
2. Type in the title.
3. Type in the link.
4. Click outside the window to close the top navigation editor and save.

You can change if links open in a new tab or the same tab by checking Open Links in New Tab.

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

Sticky Top Navigation Bar

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

1. Click on Project settings in the sidebar.
2. Under Customisation, check "Is Top Navigation Bar Sticky?"

The setting will be saved immediately.