https://github.com/sander76/mkdocs-abs-rel-plugin

MkDocs plugin for converting absolute links to relative ones.
https://github.com/sander76/mkdocs-abs-rel-plugin

Last synced: 6 months ago
JSON representation

MkDocs plugin for converting absolute links to relative ones.

• Host: GitHub
• URL: https://github.com/sander76/mkdocs-abs-rel-plugin
• Owner: sander76
• License: mit
• Created: 2018-12-17T10:36:19.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-03-03T19:34:26.000Z (over 6 years ago)
• Last Synced: 2025-10-27T03:52:02.333Z (8 months ago)
• Language: Python
• Size: 8.79 KB
• Stars: 5
• Watchers: 1
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)

[![Build Status](https://travis-ci.org/sander76/mkdocs-abs-rel-plugin.svg?branch=master)](https://travis-ci.org/sander76/mkdocs-abs-rel-plugin)

# Mkdocs absolute to relative link converter

Mkdocs officially only supports relative links. While this makes sense there are situation where it is useful to make use of absolute links. For example when creating a document with absolute links to an image folder. 

If that file is to be moved later on, links are kept intact.

## Installation

```bash

pip install mkdocs-abs-rel-plugin

```

## Usage

In your `mkdocs.yml` file add `abs-to-rel` to the plugins entry:

```yaml

plugins:

  - abs-to-rel

```