Skip to main content

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

Metadata

Release files for mkdocs-techdocs-redirects 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-techdocs-redirects 0.1.2
File Size Uploaded
mkdocs-techdocs-redirects-0.1.2.tar.gz 3.4 kB Details

Release files / mkdocs-techdocs-redirects-0.1.2.tar.gz

Download URL mkdocs-techdocs-redirects-0.1.2.tar.gz
Size 3.4 kB
Tags Source
SHA-256 checksum
How to use checksums
b5783159ad1612e2835859972af88c23b54ccc5c784b5f0e410308c49e39945f
BLAKE2b-256 checksum
How to use checksums
acbe9ab20ed414155028fe28472221b79319bb6d42d4e8d3f9ab8300214e8694
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.10.0

Release history Release notifications | RSS feed

This release

0.1.2 This release

1 release file

0.1.1

1 release file

0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page