MkDocs Site URLs

A MkDocs plugin that adds support for site-relative site: URLs.

Example:

Usage

1. Install the plugin from PyPI

   pip install mkdocs-site-urls
   

2. Add the site-urls plugin to your mkdocs.yml plugins section:

   plugins:
     - site-urls
   

   There are no configuration options.
3. Start using site-relative URLs in your Markdown files by prefixing them with site::

   [Link to another page](site:another-page/relative/to/the/site/root)
   
   ![Image](site:images/foo.png)
   

How it works

The plugin hooks into the on_page_content event and replaces all URLs in href or src attributes in the rendered HTML with the corresponding site-relative URLs.

License

This project is licensed under the MIT license, see the LICENSE file for details.