Mkdocs Redirects

Overview

The mkdocs-redirects Plugin is a handy tool designed for MkDocs, specifically aimed at creating redirects for pages that have been moved or renamed. Originally developed by DataRobot, this plugin greatly enhances the user experience by ensuring users are seamlessly directed to the new locations of content without any manual hassle. Whether you're managing a large documentation site or simply updating a few pages, the mkdocs-redirects Plugin makes the transition smooth and user-friendly.

By leveraging this plugin, developers can easily specify redirects in their MkDocs configuration, allowing for a flexible and efficient way to manage page locations. This means that even if a page's URL changes, users will automatically be redirected to the new page, preserving the integrity of your documentation and minimizing broken links.

Features

• Easy Redirect Management: Specify original markdown documents and their corresponding new paths in a straightforward key/value format within your mkdocs.yml file.

• Automatic Filename Resolution: The plugin handles filename resolution during the build process, ensuring that the redirects work correctly without any extra effort.

• Support for External URLs: Redirects can lead not only to other markdown documents but also to external URLs, making it versatile for various use cases.

• Directory URL Handling: With use_directory_urls set to true, the plugin adjusts redirect targets to point to directory URLs, which is useful for organizing content effectively.

• Real-time Warnings: The plugin produces warnings during the build if any redirect targets don't exist, aiding in maintaining a robust documentation structure.

• Seamless Integration: Easily integrate the plugin into your existing MkDocs setup without rewriting core functionalities, simplifying your documentation workflow.

• Automated Releases: The plugin supports automated releases to PyPI via GitHub Actions, streamlining the deployment process for updates and new features.