Skip to content

Edit Site Navigation

Quick guide to organize your site navigation. For more details, see the Backend & Editor guide.

Method 1: Automatic Navigation

Simply delete the nav: section from your mkdocs.yml file for automatic alphabetical navigation.

Method 2: Custom Navigation

In your mkdocs.yml file, add or modify the nav: section:

nav:
  - Home: index.md
  - Quick Start:
      - First Document: quick-guides/first-document.md
      - Change Colors: quick-guides/change-colors.md
  - Documentation: manuals/index.md

Tips:

  • Indent with 2 spaces (YAML is space-sensitive)
  • Group pages using indentation
  • Use descriptive titles
  • The file paths are relative to your docs/ folder

Enable extra navigation features in mkdocs.yml:

theme:
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.indexes