mkdocs-get-deps
An extra command for MkDocs that infers required PyPI packages from `plugins` in mkdocs.yml
Decision gist · record as of 2026-08-14
Yes—if you use MkDocs and want to avoid manually tracking plugin and theme dependencies. The tool is lightweight, actively maintained, and has no security vulnerabilities. Install it as a development dependency or globally; the low friction and permissive MIT license make it a safe addition to any MkDocs workflow.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires mkdocs.yml to exist in the current directory (or specify an alternate path with --config); relies on the official MkDocs catalog for plugin lookup.
- Low friction install with no compiled dependencies.
- Actively maintained as of the latest release date, with stable Python 3.9+ support across modern versions.
License · maintenance · safety
MIT (permissive) — MIT license permits commercial and private use with minimal restrictions—suitable for most projects.
last release 2026-03-10 (157 days) · last repo commit 2024-02-11 · 2 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 16,185,016 downloads/mo, #1,158 on PyPI
Alternatives
Verify before relying
pip install mkdocs-get-deps
# Then in a directory with mkdocs.yml:
mkdocs-get-deps
# Or save to a file:
mkdocs-get-deps > requirements.txt- Accuracy of the plugin/theme/extension catalog used for reverse lookup and whether it covers all commonly-used MkDocs extensions
- Whether the tool handles custom or third-party plugins not in the official catalog
- Performance characteristics when scanning large or complex mkdocs.yml files
What it is and what it does
mkdocs-get-deps is a command-line tool that reads your MkDocs configuration file and automatically identifies which PyPI packages you need to install to build your documentation site. It works by scanning the `plugins`, `themes`, and `markdown_extensions` sections of mkdocs.yml and cross-referencing them against a catalog of known MkDocs projects to produce a list of package names. The tool depends on importlib-metadata, mergedeep, platformdirs, and pyyaml to parse configuration and manage lookups.
The tool is designed to eliminate the manual step of figuring out which dependencies to install after configuring a MkDocs site. The approach trades off strict dependency pinning for convenience—it's most useful in development environments or for quick setup, though production CI workflows typically prefer explicit requirements files.
Use it for
- Quickly bootstrap a new MkDocs project by auto-installing all plugin and theme dependencies without manual research.
- Generate a requirements.txt snapshot of all MkDocs dependencies for a given configuration.
- Install dependencies in one command during local development by piping output to a package manager.
- Verify which packages a mkdocs.yml file declares as needed before committing to a repository.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes—if you use MkDocs and want to avoid manually tracking plugin and theme dependencies.
The tool is lightweight, actively maintained, and has no security vulnerabilities. Install it as a development dependency or globally; the low friction and permissive MIT license make it a safe addition to any MkDocs workflow.
Install
mkdocs-get-deps on PyPI
Before you install
Low friction install with no compiled dependencies. Actively maintained as of the latest release date, with stable Python 3.9+ support across modern versions.
Requires mkdocs.yml to exist in the current directory (or specify an alternate path with --config); relies on the official MkDocs catalog for plugin lookup.
License in practice
MIT license permits commercial and private use with minimal restrictions—suitable for most projects.
Quickstart
pip install mkdocs-get-deps
# Then in a directory with mkdocs.yml:
mkdocs-get-deps
# Or save to a file:
mkdocs-get-deps > requirements.txtVerify before relying
- Accuracy of the plugin/theme/extension catalog used for reverse lookup and whether it covers all commonly-used MkDocs extensions
- Whether the tool handles custom or third-party plugins not in the official catalog
- Performance characteristics when scanning large or complex mkdocs.yml files
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release >=3.9 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 4 packagesimportlib-metadatamergedeepplatformdirspyyaml |
| Maintenance | Actively maintained 157 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 16,185,016 / month, #1,158 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 4 - BetaEnvironment :: ConsoleEnvironment :: Web EnvironmentIntended Audience :: Information TechnologyLicense :: OSI Approved :: MIT LicenseOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.9Topic :: Software Development :: DocumentationTyping :: Typed |
Evidence: mkdocs_get_deps-0.2.2-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 dependency detection”
- mkdocs-get-depsScans a MkDocs configuration file to automatically detect and list…
- mkdocs-htmlproofer-pluginA MkDocs plugin that validates URLs and anchors in rendered HTML…
- mkdocs-spellcheckA spell checker plugin for MkDocs that validates spelling in…
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.
Converts Markdown text to HTML using a Python implementation of John Gruber's Markdown specification, with support for extensions.
Install it if you need to parse Markdown in Python.
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.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
Material for MkDocs is a professional theme and extension for MkDocs that transforms Markdown documentation into a responsive, searchable static site with minimal configuration.
Install it if you need to publish Markdown-based documentation as a professional static site without writing custom HTML or CSS.
See also mkdocs · mkdocs-simple-hooks · mkdocs-click · mkdocstrings · mkdocs-gen-files · mkdocs-meta-manager · mkdocs-macros-plugin · mkdocs-include-markdown-plugin · mkdocs-redirects · mkdocs-task-collector