pi-hole/mkdocs-redirects-redux — explained in plain English
Analysis updated 2026-07-13 · repo last pushed 2022-02-14
Redirect old documentation page links to renamed or moved pages so visitors never hit a dead end.
Forward visitors from an old internal page to an external web address after a site migration.
Catch broken redirect targets during the build process with helpful warnings before publishing docs.
| pi-hole/mkdocs-redirects-redux | 0-bingwu-0/live-interpreter | 0xkaz/llm-governance-dashboard | |
|---|---|---|---|
| Stars | 2 | 2 | 2 |
| Language | Python | Python | Python |
| Last pushed | 2022-02-14 | — | — |
| Maintenance | Dormant | — | — |
| Setup difficulty | easy | moderate | hard |
| Complexity | 2/5 | 2/5 | 4/5 |
| Audience | developer | general | ops devops |
Figures from each repo's GitHub metadata at analysis time.
Install via pip and add a redirects section to your mkdocs.yml configuration file.
Mkdocs-redirects-redux is a plugin for MkDocs, a popular tool for building documentation websites from simple text files. When you reorganize your documentation, rename pages, or move content around, old links can break, leading to frustrating "page not found" errors. This plugin solves that problem by automatically creating redirects, seamlessly guiding visitors from old, broken web addresses to the new, correct pages. To use it, you add a simple list to your MkDocs configuration file. You specify the old file name and the new destination, which can be another page within your documentation or even a completely external web address. When you build your documentation site, the plugin automatically generates lightweight placeholder pages for all the old addresses. If someone visits an old link, these placeholders instantly forward them to the new location. The plugin also respects MkDocs's default behavior of creating clean, directory-style web addresses. It automatically figures out the correct folder structure and file placement so that your redirects align perfectly with how MkDocs naturally organizes your website. If the plugin detects that a redirect target doesn't actually exist, it will warn you during the build process, which is especially helpful if you are carefully reviewing your documentation for accuracy. This tool is ideal for technical writers, product managers, or anyone who manages a documentation website built with MkDocs. For example, if your company renames a feature from "Dashboard" to "Control Panel" and updates the documentation accordingly, you would use this plugin to ensure anyone clicking an old bookmark or finding an old search engine link still reaches the correct, updated page. The project is built in Python and designed to integrate directly into the standard MkDocs build process. Pull requests and bug reports are welcomed from the community, and the developers have provided straightforward instructions for setting up a local environment to build, test, and contribute to the project.
An MkDocs plugin that automatically creates redirects when you reorganize or rename documentation pages. It ensures old links forward visitors to the new correct pages, preventing broken-link errors.
Mainly Python. The stack also includes Python, MkDocs.
Dormant — no commits in 2+ years (last push 2022-02-14).
Setup difficulty is rated easy, with roughly 5min to a first successful run.
Mainly developer.
This repo across BitVibe Labs
Verify against the repo before relying on details.