mkdocs_literate_nav_summary_file_generator_from_directory_scan.py

1import os
2from pathlib import Path
3
4def generate_nav():
5    # This example demonstrates how to programmatically generate a 
6    # SUMMARY.md file content, which mkdocs-literate-nav uses to build navigation.
7    
8    docs_dir = Path("docs")
9    nav_lines = ["# Navigation", ""]
10    
11    # Walk through the docs directory to find all markdown files
12    for path in sorted(docs_dir.rglob("*.md")):
13        if path.name == "SUMMARY.md":
14            continue
15            
16        # Calculate depth for indentation
17        depth = len(path.relative_to(docs_dir).parts) - 1
18        indent = "  " * depth
19        
20        # Format: * [Title](path/to/file.md)
21        title = path.stem.replace("-", " ").replace("_", " ").capitalize()
22        link = path.relative_to(docs_dir).as_posix()
23        nav_lines.append(f"{indent}* [{title}]({link})")
24    
25    # Save the generated content to the summary file
26    with open(docs_dir / "SUMMARY.md", "w", encoding="utf-8") as f:
27        f.write("\n".join(nav_lines))
28
29if __name__ == "__main__":
30    generate_nav()