A MkDocs plugin to redirect old links to new addresses for TechDocs.
Reason this release was yanked:
Error in docs
Project description
mkdocs-techdocs-redirect
Plugin to handle redirections for techdocs sites.
Uses 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-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.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2f7a7a7730f14cce819f9a3e6861245234ca4fbab776210b8f0abe423e7ca34c |
|
MD5 | e1780bfeafb6151e909738408bdbe548 |
|
BLAKE2b-256 | d7bda4e0d1f4747327f06cb51ea0cda7339e528fb4db3e283252265beb87f636 |