Install & Compatibility
Where this runs
tested against v1.7.1 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.95 runs
installs and imports cleanly · install 0.0s · import 0.000s · 151.4MB
glibcpy 3.10–3.95 runs
installs and imports cleanly · install 8.6s · import 0.000s · 153MB
150MB installed
● package 150MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
techdocs-core
✓ plugins:
- techdocs-core
The plugin is configured in mkdocs.yml, not imported as a Python module in application code.
This quickstart demonstrates how to set up a basic MkDocs project using `mkdocs-techdocs-core`. It involves creating a project structure, configuring `mkdocs.yml` to enable the plugin, and adding a simple Markdown file, then serving the documentation locally. Make sure you have `mkdocs` installed globally or in your environment (`pip install mkdocs`).
# 1. Create a project directory (e.g., 'my-techdocs-site')
# 2. Inside 'my-techdocs-site', create an 'mkdocs.yml' file:
# ---
# site_name: My TechDocs Project
# nav:
# - Home: index.md
# plugins:
# - techdocs-core
# ---
# 3. Inside 'my-techdocs-site', create a 'docs' directory.
# 4. Inside 'docs', create an 'index.md' file:
# ---
# # Welcome to My TechDocs Project!
#
# This is your documentation generated with MkDocs TechDocs Core.
# ---
# 5. Run MkDocs serve from the 'my-techdocs-site' directory:
# mkdocs serve
mkdocs --version
Debug
Known issues
breakingDirect MkDocs Material theme overrides in `mkdocs.yml` might not work as expected due to `mkdocs-techdocs-core` hardcoding certain features (e.g., `navigation.footer` enabled, `theme.palette` reset) for Backstage consistency.fixAvoid extensive theme customization in `mkdocs.yml` when using `mkdocs-techdocs-core` in a Backstage environment. Rely on Backstage's `BackstageTheme` for styling. If customization is critical, test thoroughly and be aware of potential overrides.
affects: All versions (specifically with `mkdocs-material` v9+)
gotcha`mkdocs-techdocs-core` bundles many other MkDocs plugins (e.g., `search`, `mkdocs-monorepo-plugin`, `pymdown-extensions`). Explicitly listing these individual plugins in your `mkdocs.yml` *in addition to* `techdocs-core` can lead to 'plugin not installed' errors or conflicting behavior, as `techdocs-core` already manages their inclusion.fixDo not configure individual plugins that are known to be bundled within `techdocs-core`. If you need additional plugins not included in the core bundle, install and configure them separately in your `mkdocs.yml` *after* `techdocs-core`.
affects: All versions
gotchaThe bundled `plantuml-markdown` extension in `mkdocs-techdocs-core` does not support the `svg_object` format for rendering diagrams due to security vulnerabilities (CVE-2021-32661). Using this format will result in diagrams not rendering.fixUse the `svg_inline` format instead of `svg_object` for PlantUML diagrams: ``.
affects: All versions
breakingThe library requires Python version 3.9 or higher. Using an older Python version (e.g., 3.8 or 3.7) will lead to installation failures or runtime errors.fixEnsure your environment is running Python 3.9 or a newer compatible version.
affects: <1.0.0 (required >=3.8), >=1.0.0 (required >=3.9)
Upgrade
Version history
1.7.1latest on PyPI · released Aug 21, 2026
Audit
Dependencies
No dependency data recorded yet.