mkdocs_techdocs_core_plugin_minimal_config_and_build.py

1# Note: mkdocs-techdocs-core is typically configured in mkdocs.yml.
2# To use it programmatically in a Python script (e.g., for a custom build):
3
4import mkdocs.config
5from mkdocs.commands.build import build
6
7# Define the configuration as a Python dictionary
8config_dict = {
9    "site_name": "My TechDocs Project",
10    "plugins": [
11        "techdocs-core"
12    ],
13    "theme": {
14        "name": "techdocs"
15    }
16}
17
18# Load the configuration
19# This mimics the 'mkdocs build' command using the techdocs-core plugin
20cfg = mkdocs.config.load_config(
21    config_file="mkdocs.yml", # Point to your file or provide the dict
22    theme={"name": "techdocs"},
23    plugins=["techdocs-core"]
24)
25
26# Run the build
27build(cfg)