mkdocs_material_theme_project_initialization_and_build.py

1# Note: mkdocs-material is primarily configured via a YAML file (mkdocs.yml).
2# However, you can manage the project via Python using the mkdocs package.
3
4import os
5from mkdocs.commands.new import new
6from mkdocs.commands.build import build
7from mkdocs.config import load_config
8
9# 1. Initialize a new project structure
10project_name = "my-docs"
11if not os.path.exists(project_name):
12    new(project_name)
13
14# 2. Configure the mkdocs.yml file to use the Material theme
15# In a real scenario, you would edit the file directly:
16config_content = """
17site_name: My Docs
18theme:
19  name: material
20"""
21with open(os.path.join(project_name, "mkdocs.yml"), "w") as f:
22    f.write(config_content)
23
24# 3. Build the documentation programmatically
25os.chdir(project_name)
26config = load_config()
27build(config)
28
29print(f"Project '{project_name}' created and built successfully with Material theme.")