Mkdocs

docforge.nav.mkdocs

This module provides the MkDocsNavEmitter, which converts a ResolvedNav instance into the specific YAML-ready list structure expected by the MkDocs 'nav' configuration.

MkDocsNavEmitter

Emitter responsible for transforming a ResolvedNav into an MkDocs-compatible navigation structure.

emit

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

Generate a list of navigation entries for mkdocs.yml.

Parameters:

Name	Type	Description	Default
nav	ResolvedNav	The resolved navigation data.	required

Returns:

Type	Description
List[Dict[str, Any]]	A list of dictionary mappings representing the MkDocs navigation.