mkdocs-techdocs-core
The core MkDocs plugin used by Backstage's TechDocs as a wrapper around multiple MkDocs plugins and Python Markdown extensions
Decision gist · record as of 2026-08-14
Yes, if you are using Backstage TechDocs or want a pre-assembled, actively maintained MkDocs plugin bundle with Material theming and common extensions. The low install friction, permissive license, and zero known vulnerabilities make it safe to adopt. Not necessary if you prefer to configure MkDocs plugins individually or use a different documentation system.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python >= 3.9.
- Designed as an MkDocs plugin, so an existing mkdocs.yml configuration file is needed.
- Low install friction with a pure-Python wheel.
License · maintenance · safety
Apache-2.0 (permissive) — Apache-2.0 permissive license allows commercial and private use with minimal restrictions.
last release 2026-06-10 (65 days)
0 known vulnerabilities (OSV.dev, 2026-08-14) · 799,047 downloads/mo, #5,026 on PyPI
Alternatives
Verify before relying
pip install mkdocs-techdocs-core
# Add to mkdocs.yml:
plugins:
- techdocs-core
# Optional: enable material search
plugins:
- techdocs-core:
use_material_search: true- Whether the 12 runtime dependencies (mkdocs, mkdocs-material, plantuml-markdown, etc.) are all actively maintained and compatible with each other.
- Performance impact of bundling all extensions and plugins together versus selective use.
- Compatibility with custom MkDocs themes or plugins not included in the bundle.
What it is and what it does
mkdocs-techdocs-core is an MkDocs plugin that packages Spotify's TechDocs documentation defaults into a single, drop-in component. It bundles theming (Material for MkDocs), multiple plugins (monorepo support, GitHub admonitions, search, redirects), and Markdown extensions (PyMdown, syntax highlighting, PlantUML, Graphviz inline rendering, and more) so you don't have to configure them individually.
Instead of manually adding and configuring a dozen separate MkDocs plugins and extensions, you install this package and add `techdocs-core` to your `mkdocs.yml`. It's designed for teams using Backstage's TechDocs feature but works as a standalone MkDocs plugin. The plugin supports optional features like material-based search indexing and PyMdown Blocks extensions via configuration flags.
Use it for
- Generate documentation sites within Backstage TechDocs using pre-configured MkDocs defaults.
- Build monorepo documentation where multiple sub-projects need separate doc sets in one site.
- Create technical documentation with built-in support for PlantUML diagrams and Graphviz inline rendering.
- Standardize documentation styling and plugin configuration across a team or organization.
- Render GitHub-style alert syntax (NOTE, TIP, WARNING) as MkDocs admonitions without extra setup.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you are using Backstage TechDocs or want a pre-assembled, actively maintained MkDocs plugin bundle with Material theming and common extensions.
The low install friction, permissive license, and zero known vulnerabilities make it safe to adopt. Not necessary if you prefer to configure MkDocs plugins individually or use a different documentation system.
Install
mkdocs-techdocs-core on PyPI
Before you install
Low install friction with a pure-Python wheel. Actively maintained with a release 65 days ago. Supports current Python versions (3.9+).
Requires Python >= 3.9. Designed as an MkDocs plugin, so an existing mkdocs.yml configuration file is needed.
License in practice
Apache-2.0 permissive license allows commercial and private use with minimal restrictions.
Quickstart
pip install mkdocs-techdocs-core
# Add to mkdocs.yml:
plugins:
- techdocs-core
# Optional: enable material search
plugins:
- techdocs-core:
use_material_search: true
Verify before relying
- Whether the 12 runtime dependencies (mkdocs, mkdocs-material, plantuml-markdown, etc.) are all actively maintained and compatible with each other.
- Performance impact of bundling all extensions and plugins together versus selective use.
- Compatibility with custom MkDocs themes or plugins not included in the bundle.
Package facts
| License | Apache-2.0 permissive |
| Python support | Supports the current Python release >=3.9 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 12 packagesmkdocsMarkdownmkdocs-materialmarkdown-graphviz-inlinemkdocs-github-admonitions-pluginmkdocs-monorepo-pluginplantuml-markdownmdx_truly_sane_listspymdown-extensionspygmentsmkdocs-redirectsclick |
| Maintenance | Actively maintained 65 days since the last release |
| First released | |
| Downloads | 799,047 / month, #5,026 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 3 - AlphaIntended Audience :: DevelopersIntended Audience :: Information TechnologyProgramming Language :: PythonProgramming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14 |
Evidence: mkdocs_techdocs_core-1.7.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “mkdocs plugin documentation”
- mkdocs-techdocs-coreBundles Spotify's TechDocs defaults—themes, plugins, and Markdown…
- mkdocs-simple-hooksA MkDocs plugin that lets you define custom hooks directly in your…
- mkdocs-excludeA mkdocs plugin that excludes files and directories from…
Give your agent the search over MCP, or paste the wish link into any chat.
More Documentation packages
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
Griffe extracts the complete structure and signatures of Python programs to generate API documentation or detect breaking changes in your project's public API.
Install it if you need to programmatically inspect Python code structure, generate API docs, or enforce API stability in CI.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
See also mkdocs-monorepo-plugin · mkdocs-material · mdformat-mkdocs · mkdocstrings · mkdocs-multirepo-plugin · mkdocs-print-site-plugin · mkdocs · mkdocstrings-python-legacy · properdocs · mkdocs-git-committers-plugin-2