mkdocs_literate_nav_markdown_summary_generator.py

1import os
2
3# This script demonstrates how to programmatically generate a SUMMARY.md 
4# file (or any file used for navigation) that mkdocs-literate-nav will parse.
5
6def generate_nav():
7    pages = [
8        {"Home": "index.md"},
9        {"User Guide": [
10            {"Installation": "guide/install.md"},
11            {"Configuration": "guide/config.md"}
12        ]},
13        {"About": "about.md"}
14    ]
15    
16    lines = []
17    
18    def walk_nav(nav_item, depth=0):
19        indent = "  " * depth
20        for item in nav_item:
21            for title, path in item.items():
22                if isinstance(path, list):
23                    lines.append(f"{indent}* {title}")
24                    walk_nav(path, depth + 1)
25                else:
26                    lines.append(f"{indent}* [{title}]({path})")
27
28    walk_nav(pages)
29    
30    # In a real quickstart, you would write this to a file like 'docs/SUMMARY.md'
31    # which mkdocs-literate-nav then reads to build your site structure.
32    content = "\n".join(lines)
33    print(content)
34
35if __name__ == "__main__":
36    generate_nav()