mkdocs_material_pip_install_and_basic_config_verification.py

1# 1. Install the package via terminal/shell:
2# pip install mkdocs-material
3
4# 2. While MkDocs is configured via YAML, you can verify the installation 
5# and theme availability programmatically in Python:
6
7import mkdocs.config
8import mkdocs.utils
9
10def create_basic_config():
11    # This represents the internal configuration structure that 
12    # Material for MkDocs uses when you run 'mkdocs build'
13    config_scheme = {
14        'site_name': 'My Docs',
15        'theme': {
16            'name': 'material'  # This activates the Material theme
17        }
18    }
19    
20    print(f"Material for MkDocs theme '{config_scheme['theme']['name']}' is ready to use.")
21
22if __name__ == "__main__":
23    create_basic_config()
24
25# To view your site, run the following in your terminal:
26# mkdocs new .
27# mkdocs serve