A MkDocs plugin to redirect old links to new addresses for TechDocs.
Project description
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?
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for mkdocs-techdocs-redirects-0.1.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b5783159ad1612e2835859972af88c23b54ccc5c784b5f0e410308c49e39945f |
|
MD5 | 238f965095c9153ef4253be088b11d6c |
|
BLAKE2b-256 | acbe9ab20ed414155028fe28472221b79319bb6d42d4e8d3f9ab8300214e8694 |