Skip to main content

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

Project description

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: ✉

Project details


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.1.3.tar.gz (2.2 kB view hashes)

Uploaded Source

Built Distribution

mkdocs_link_marker-0.1.3-py3-none-any.whl (2.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page