MkDocs Link Marker

Warnings

• gotcha Starting from v0.2.0, external links that are part of an image (``) are no longer marked by default. If you relied on this behavior, you might notice a change in your documentation output.
  Fix: This change is intentional for better user experience, as marking image links can sometimes clutter the output. No direct configuration option exists to re-enable marking these specific links.
• gotcha Version 0.3.0 introduced new configuration options like `ignore_urls` and `extra_external_attrs`. Failing to configure these might lead to undesired link marking or lack of specific attributes, particularly if you need to exclude certain domains from being marked or add custom HTML attributes like `target="_blank"` and `rel="noopener"` for external links.
  Fix: Review the plugin's configuration options in your `mkdocs.yml`. Explicitly define `ignore_urls` for links you don't want marked and `extra_external_attrs` to add custom attributes to external links, for example: plugins: - link-marker: ignore_urls: ['docs.example.com', 'internal.network'] extra_external_attrs: {'target': '_blank', 'rel': 'noopener'}

Install

• pip install mkdocs-link-marker Install with pip

Imports

• link-marker (plugin entry)

  plugins:
    - link-marker

  MkDocs plugins are configured directly in mkdocs.yml, not imported as Python symbols.

Quickstart

To enable the mkdocs-link-marker plugin, add `link-marker` to the `plugins` section of your `mkdocs.yml` file. You can also configure various options such as custom icons for external and mail links, a list of URLs to ignore, and extra HTML attributes for external links.

site_name: My Docs

plugins:
  - search
  - link-marker: # Enable the link-marker plugin
      # Optional configuration:
      # external_icon: ' 🔗'
      # mail_icon: ' ✉️'
      # ignore_urls: ['www.example.com']
      # extra_external_attrs: {'target': '_blank', 'rel': 'noopener'}