Navigation Sorting Controls

Create a helper that configures navigation sorting for a docs site using the dependency's sort options. The helper should rely on the dependency to apply ordering rather than manual sorting.

Capabilities

Root pages sorted descending, ignoring case

• With a docs root containing pages API.md, guide.md, LICENSE.md and a guides/ section, the navigation lists the root pages in descending alphabetical order ignoring case, followed by the Guides section. Expected titles sequence: Guide, LICENSE, API, Guides. @test

Sections first within guides

• Inside guides/ containing a tutorials/ subsection and markdown pages lesson1.md, lesson2.md, the navigation places sections before pages and keeps page titles in natural ascending order. Expected titles sequence within Guides: Tutorials, Lesson 1, Lesson 2. @test

Deep glob ordering by filename

• When collecting all markdown files under reference/ via a deep glob, items are sorted by filename rather than full path and respect descending order, so api.md in reference/v1/ appears before concepts.md in reference/v2/ when their filenames sort that way. @test

Implementation

@generates

API

from pathlib import Path
from typing import List

def build_sorted_nav(docs_root: Path) -> List[str]:
    """
    Build the navigation for docs_root using the dependency's sorting controls and return
    the ordered display titles (including section headings) as they appear in the final nav.
    """

Dependencies { .dependencies }

mkdocs-awesome-pages-plugin { .dependency }

Provides navigation sorting controls for MkDocs.