Navigation File Reference

The navigation for a project is configured in navigation.yaml files. This is the navigation you see on the left side of the screen (or in the mobile navigation if on a mobile device).

Each tab or subtab has a corresponding navigation.yaml file.

For usage and examples, see sidebar navigation.

Configuration Example

An example navigation.yaml demonstrating the available configuration options.

---
- heading: Introduction
  items:
  - label: What is Doctave?
    href: /introduction/what-is-doctave.md
  - label: Doctave Dashboard
    external: https://dashboard.doctave.com

- heading: Projects
  items: 
  - label: Basics
    href: /projects/basics.md
  - label: Settings
    href: /projects/settings.md
    items:
    - label: Look and Feel
      href: /projects/settings/look-and-feel.md
    - label: Content Filters
      href: /projects/content-filtering-with-user-preferences.md
  - label: Pages
    href: /projects/pages.md
  - label: Domains
    href: /projects/domains.md

- heading: Reference
  items:
  - label: Configration Files
    href: /docs/reference/configuration-files.md
    items:
    - label: Project
      href: /docs/reference/doctave-yaml.md
    - label: Navigation
      href: /docs/reference/navigation-yaml.md

- heading: API Reference
  items:
  - open_api_spec: http_spec.json

Reference

Below are explanations of all the objects and their fields in the navigation structure. Your navigation.yaml should contain a list of these objects.

Heading

field description required? default
heading The title of the section false
collapsed Should the list of children be collapsed false false
collapsible Can the list of children be collapsed (true, if collapsed is set) false false
items List of Links, Subheadings or OpenAPI navigation objects false []
show_if See content filters false

Subheading

field description required? default
subheading Text to display for the subheading true
collapsed Should the list of children be collapsed false false
collapsible Can the list of children be collapsed (true, if collapsed is set) false false
items List of Links, Subheadings false []
show_if See content filters false

Link

field description required? default
label Text to display for the link true
href Page the link should point to. false*
external External page the link should point to. false*
collapsed Should the list of children be collapsed false false
collapsible Can the list of children be collapsed (true, if collapsed is set) false false
items List of Links, Subheadings false []
show_if See content filters false

*You must specify either external or href for a link

OpenAPI

The open_api_spec expands your API definition into navigation sections based on your OpenAPI tags.

field description required? default
open_api_spec The path to the OpenAPI spec in your project. Must be mentioned in your doctave.yaml file true
only Limit which OpenAPI tag pages to include links for. See filtering tags false
show_if See content filters false

Was this page helpful?

On This Page