mkdocs-link-marker is an MkDocs plugin designed to automatically mark external or mailto links within your documentation, enhancing user experience by visually distinguishing these links. It is currently at version 0.3.0 and maintains an active development cycle with regular updates addressing features and fixes.
pip install mkdocs-link-markerVerified import paths — ran on the pinned version, not inferred.
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.
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.
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'}