mkdocs-techdocs-redirects 0.1.2

A MkDocs plugin to redirect old links to new addresses for TechDocs.

mkdocs-techdocs-redirect

Plugin to handle redirections for techdocs sites.

Uses (almost) the same config and is inspired by and initially forked from mkdocs-redirects.

Installing

note: This package requires MkDocs version 1.0.4 or higher.

Install with pip:

pip install mkdocs-techdocs-redirects

Using

To use this plugin, specify your desired redirects in the plugin's redirect_maps setting in your mkdocs.yml:

plugins:
    - redirects:
        redirect_maps:
            'old': 'new'
            'old/file': 'new/file'
            'some_path': 'http://external.url.com/foobar'

Opposite to what mkdocs-redirects does, do not specify .md or .html. We are running in TechDocs only.

Looking to contribute?

• Please propose tests.

More docs? How to setup on backstage?

Read the TechDocs