feat: adding reuse capabilities through include-markdown

.gitignore

@@ -13,3 +13,7 @@ site
 # Generated files
 generated/
 .DS_Store
+
+# Python cache
+__pycache__/
+*.pyc

mkdocs/hooks.py

@@ -0,0 +1,17 @@
+"""MkDocs hooks to configure SSL certificates for include-markdown plugin."""
+import ssl
+import certifi
+
+# Monkey patch urllib to use certifi's certificate bundle
+def on_startup(**kwargs):
+    """Configure SSL context to use certifi certificates."""
+    import urllib.request
+
+    # Create SSL context with certifi's certificate bundle
+    ssl_context = ssl.create_default_context(cafile=certifi.where())
+
+    # Set the default opener to use this context
+    https_handler = urllib.request.HTTPSHandler(context=ssl_context)
+    opener = urllib.request.build_opener(https_handler)
+    urllib.request.install_opener(opener)
+

mkdocs/mkdocs.yml

@@ -24,6 +24,9 @@ markdown_extensions:
           class: mermaid
           format: !!python/name:pymdownx.superfences.fence_code_format
 
+hooks:
+  - hooks.py
+
 plugins:
   search:
   awesome-pages:
@@ -73,6 +76,8 @@ plugins:
     raise_error: false
     raise_error_after_finish: false
     validate_external_urls: true
+  include-markdown:
+
 theme:
   name: material
   custom_dir: overrides

mkdocs/pyproject.toml

@@ -22,8 +22,10 @@ dependencies = [
     "agntcy-iomapper==0.2.2",
     "beautifulsoup4>=4.13.3",
     "mkdocs-swagger-ui-tag==0.7.1",
+    "mkdocs-include-markdown-plugin>=7.2.0",
     # Linting and testing tools
     "codespell>=2.2.0",
     "pymarkdownlnt>=0.9.0",
     "mkdocs-htmlproofer-plugin>=1.0.0",
+    "certifi>=2025.1.31",
 ]