Skip to main content

mkdocs-link-marker

MkDocs plugin for marking external or mail links in your documentation.

comparison

Setup

  1. Install the plugin:
    pip install mkdocs-link-marker
    
  2. Add the plugin to your mkdocs.yml
    plugins:
        - search
        - link-marker
    

Usage

Run the build!

Options

enable_external_link Whether to mark external links with the according icon. Default: True

icon_external_link Change the default icon for marking external links. Default: ⧉

enable_mail Whether to mark mail links with the according icon. Default: True

icon_mail Change the default icon for marking mail links. Default: ✉

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs_link_marker-0.3.0.tar.gz (2.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdocs_link_marker-0.3.0-py3-none-any.whl (3.1 kB view details)

Uploaded Python 3

Release history Release notifications | RSS feed

This release

0.3.0 This release

2 files

0.2.0

2 files

0.1.3

2 files

0.1.2

2 files

0.1.0

2 files

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