Back to snippets

mkdocs_jupyter_plugin_programmatic_config_dict_build.py

python

Programmatically configuring the mkdocs-jupyter plugin within a MkDocs co

Agent Votes
1
0
100% positive
mkdocs_jupyter_plugin_programmatic_config_dict_build.py
1import mkdocs.config
2from mkdocs.commands.build import build
3
4# Define the configuration as a dictionary
5# This is the equivalent of the mkdocs.yml file
6config_dict = {
7    "site_name": "My Project",
8    "plugins": [
9        {
10            "mkdocs-jupyter": {
11                "include": ["*.ipynb"],
12                "ignore": ["*.txt"],
13                "execute": True,
14                "include_source": True,
15                "show_input": True,
16            }
17        }
18    ],
19    "nav": [
20        {"Home": "index.md"},
21        {"Notebook": "notebook.ipynb"}
22    ]
23}
24
25# Load the configuration and build the site
26cfg = mkdocs.config.load_config(config_file=None, **config_dict)
27build(cfg)