whatisgithub

What is mkdocs-redirects-redux?

pi-hole/mkdocs-redirects-redux — explained in plain English

Analysis updated 2026-07-13 · repo last pushed 2022-02-14

2PythonAudience · developerComplexity · 2/5DormantSetup · easy

In one sentence

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.

Mindmap

mindmap
  root((repo))
    What it does
      Creates page redirects
      Generates placeholder pages
      Warns on missing targets
    How it works
      MkDocs config entry
      Old path to new path
      Internal or external links
    Tech stack
      Python
      MkDocs
    Use cases
      Renamed feature pages
      Reorganized docs sites
      External link forwarding
    Audience
      Technical writers
      Product managers
      Docs maintainers
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Redirect old documentation page links to renamed or moved pages so visitors never hit a dead end.

USE CASE 2

Forward visitors from an old internal page to an external web address after a site migration.

USE CASE 3

Catch broken redirect targets during the build process with helpful warnings before publishing docs.

What is it built with?

PythonMkDocs

How does it compare?

pi-hole/mkdocs-redirects-redux0-bingwu-0/live-interpreter0xkaz/llm-governance-dashboard
Stars222
LanguagePythonPythonPython
Last pushed2022-02-14
MaintenanceDormant
Setup difficultyeasymoderatehard
Complexity2/52/54/5
Audiencedevelopergeneralops devops

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min

Install via pip and add a redirects section to your mkdocs.yml configuration file.

So what is it?

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.

Copy-paste prompts

Prompt 1
Help me install and configure mkdocs-redirects-redux in my MkDocs project so that old page URLs redirect to their new locations
Prompt 2
Show me the mkdocs.yml config syntax for mkdocs-redirects-redux to redirect an old page to a new page and another old page to an external URL
Prompt 3
Walk me through building my MkDocs site with mkdocs-redirects-redux and explain how to interpret the missing-target warnings it produces during the build

Frequently asked questions

What is mkdocs-redirects-redux?

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.

What language is mkdocs-redirects-redux written in?

Mainly Python. The stack also includes Python, MkDocs.

Is mkdocs-redirects-redux actively maintained?

Dormant — no commits in 2+ years (last push 2022-02-14).

How hard is mkdocs-redirects-redux to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is mkdocs-redirects-redux for?

Mainly developer.

Open on GitHub → Ask about another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.