Skip to content

Latest commit

 

History

History
45 lines (24 loc) · 2.63 KB

File metadata and controls

45 lines (24 loc) · 2.63 KB
graph LR
    mkdocs_structure_files_Files["mkdocs.structure.files.Files"]
    mkdocs_structure_pages_Page["mkdocs.structure.pages.Page"]
    mkdocs_structure_nav_Navigation["mkdocs.structure.nav.Navigation"]
    mkdocs_structure_files_Files -- "provides raw source files to" --> mkdocs_structure_pages_Page
    mkdocs_structure_pages_Page -- "provides structured page objects to" --> mkdocs_structure_nav_Navigation
Loading

CodeBoardingDemoContact

Details

The Content Processing Pipeline subsystem orchestrates the transformation of raw source content into structured data ready for rendering. It operates as a sequential flow from raw source discovery to structured content and navigation, forming the core of content processing within MkDocs.

mkdocs.structure.files.Files

Responsible for identifying and managing all source files. Discovers, categorizes, and provides access to all project source files (Markdown, static assets). It also manages the copying of static files to the build output directory.

Related Classes/Methods:

mkdocs.structure.pages.Page

Handles the processing and structuring of individual content pages. Parses raw Markdown content into HTML, extracts front-matter metadata (e.g., title, date), and resolves internal links within the content. It encapsulates all structured data for a single documentation page.

Related Classes/Methods:

mkdocs.structure.nav.Navigation

Constructs the overall site navigation hierarchy. Constructs the hierarchical navigation structure of the entire site. This involves ordering and nesting pages and sections based on the processed Page objects and the mkdocs.yml configuration.

Related Classes/Methods: