Set up navigation

The docs.yml file configures your whole documentation site, from visual styling to navigation. Navigation covers the tabs, sections, and pages that make up your site’s structure. These settings determine what readers see in the sidebar and top bar, and how they move between pages.

Quick example

Here’s a minimal example showing navigation structure in docs.yml:

1
navigation:
2
  - section: Getting started
3
    contents:
4
      - page: Introduction
5
        path: docs/pages/intro.mdx
6
      - page: Quickstart
7
        path: docs/pages/quickstart.mdx
8
  - api: API Reference

Complete navigation options

Explore the navigation options below and click through to the Fern documentation for detailed configuration guides.