Mkdocs

docforge.nav.mkdocs

MkDocs navigation emitter.

This module provides the MkDocsNavEmitter class, which converts a ResolvedNav instance into the navigation structure required by the MkDocs nav configuration.

Classes

MkDocsNavEmitter

Emit MkDocs navigation structures from resolved navigation data.

The emitter transforms a ResolvedNav object into the YAML-compatible list structure expected by the MkDocs nav configuration field.

Functions

emit

emit(nav: ResolvedNav) -> List[Dict[str, Any]]

Generate a navigation structure for mkdocs.yml.

Parameters:

Name	Type	Description	Default
nav	ResolvedNav	Resolved navigation data describing documentation groups and their associated Markdown files.	required

Returns:

Type	Description
List[Dict[str, Any]]	A list of dictionaries representing the MkDocs navigation layout.
List[Dict[str, Any]]	Each dictionary maps a navigation label to a page or a list of
List[Dict[str, Any]]	pages.