mkdocs-redirects
A MkDocs plugin for dynamic page redirects to prevent broken links
Decision gist · record as of 2026-08-14
Yes. The plugin is production-stable (Development Status 5), actively maintained, has no known vulnerabilities, and solves a common documentation management problem with minimal dependencies. Install it if you maintain MkDocs documentation and anticipate or have already restructured pages; it's low-friction and permissively licensed.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires MkDocs to be installed and a mkdocs.yml configuration file to specify redirect mappings.
- Low install friction: pure Python wheel with only mkdocs and properdocs as runtime dependencies.
- Actively maintained with a recent release (139 days ago) and ongoing repository activity.
License · maintenance · safety
MIT (permissive) — MIT license permits unrestricted use, modification, and distribution with minimal obligations—suitable for both open-source and commercial projects.
last release 2026-03-28 (139 days) · last repo commit 2026-04-16 · 3 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 1,683,733 downloads/mo, #3,656 on PyPI
Alternatives
Verify before relying
pip install mkdocs-redirects
# In mkdocs.yml:
plugins:
- redirects:
redirect_maps:
'old.md': 'new.md'
'old/file.md': 'http://external.url.com'- Whether properdocs is a required runtime dependency or an optional feature—the fact sheet lists it but does not clarify its role.
- How the plugin handles redirect chains (old → intermediate → final) or circular redirects.
- Performance impact when redirect_maps contains hundreds or thousands of entries.
What it is and what it does
mkdocs-redirects is a plugin for MkDocs that automatically generates HTTP redirect pages when documentation files are moved or renamed. During the build process, it creates .html files at the old file paths that redirect browsers to the new locations, preventing broken links when documentation structure changes.
You configure redirects declaratively in mkdocs.yml using a redirect_maps dictionary, where keys are original markdown file paths and values are either new markdown paths or external URLs. The plugin handles URL resolution automatically, respecting MkDocs' use_directory_urls setting to generate correct relative or absolute redirect targets. It also produces warnings if redirect targets don't exist, which is useful when strict mode is enabled.
Use it for
- Reorganizing documentation structure without breaking existing external links or bookmarks to old pages.
- Migrating documentation to a new domain or external platform while maintaining backward compatibility.
- Renaming or moving individual pages within a growing documentation site without losing SEO or user navigation.
- Consolidating duplicate pages by redirecting old versions to a canonical new location.
- Handling documentation refactors where entire directory hierarchies are restructured.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
The plugin is production-stable (Development Status 5), actively maintained, has no known vulnerabilities, and solves a common documentation management problem with minimal dependencies. Install it if you maintain MkDocs documentation and anticipate or have already restructured pages; it's low-friction and permissively licensed.
Install
mkdocs-redirects on PyPI
Before you install
Low install friction: pure Python wheel with only mkdocs and properdocs as runtime dependencies. Actively maintained with a recent release (139 days ago) and ongoing repository activity.
Requires MkDocs to be installed and a mkdocs.yml configuration file to specify redirect mappings.
License in practice
MIT license permits unrestricted use, modification, and distribution with minimal obligations—suitable for both open-source and commercial projects.
Quickstart
pip install mkdocs-redirects
# In mkdocs.yml:
plugins:
- redirects:
redirect_maps:
'old.md': 'new.md'
'old/file.md': 'http://external.url.com'Verify before relying
- Whether properdocs is a required runtime dependency or an optional feature—the fact sheet lists it but does not clarify its role.
- How the plugin handles redirect chains (old → intermediate → final) or circular redirects.
- Performance impact when redirect_maps contains hundreds or thousands of entries.
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 2 packagesmkdocsproperdocs |
| Maintenance | Actively maintained 139 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 1,683,733 / month, #3,656 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableEnvironment :: 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.14Topic :: DocumentationTopic :: Software Development :: DocumentationTopic :: Text Processing :: Markup :: MarkdownTyping :: Typed |
Evidence: mkdocs_redirects-1.2.3-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 page redirects”
- mkdocs-redirectsA MkDocs plugin that generates HTTP redirects for moved or renamed…
- mkdocs-section-indexMkDocs plugin that makes section headers clickable by merging an…
- sphinxext-rediraffeA Sphinx extension that automatically redirects requests for…
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 mike · mkdocs-multirepo-plugin · mkdocs-include-markdown-plugin · mkdocs-same-dir · mkdocs-gen-files · mkdocs-autorefs · mkdocs-htmlproofer-plugin · mkdocs-literate-nav · sphinx-reredirects · sphinxext-rediraffe