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.
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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 60b53b08c34fec74ca8ff265c25160db1bc68cdacf6729754b8e529e8be6799d |
|
MD5 | 8b0c72a86aa332f177a4be633a6d5399 |
|
BLAKE2b-256 | 0d7a028c1b9a36e1500e7175b2cd1050b6a76602b6866842d0dfc431c98a2f73 |