mkdocs-link-marker

What it is and what it does

mkdocs-link-marker is a MkDocs plugin that automatically decorates links in your documentation with visual markers. It intercepts the build process and adds icons next to external URLs and email addresses, making it immediately clear to readers which links leave the site or trigger an email client. The plugin works by integrating with MkDocs' plugin architecture and uses Jinja2 templating to inject the markers during rendering.

You configure it by adding it to your mkdocs.yml file, then control its behavior through simple options: enable or disable external link marking and email marking separately, and customize the icons used (defaulting to ⧉ for external links and ✉ for email). Once configured, it requires no further action—the markers appear automatically when you build your documentation.

Use it for:

• Mark all external links in a documentation site to help users distinguish internal navigation from outbound links.
• Add email icons to mailto: links so readers know they will open an email client.
• Customize link markers to match your documentation's visual style or accessibility requirements.
• Improve user experience in large documentation projects by making link destinations immediately obvious.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

A MkDocs plugin that automatically marks external links and email links in your documentation with configurable icons during the build process.

Yes. The plugin is lightweight, actively maintained, has no security vulnerabilities, and solves a real UX problem in documentation. Install it if you want automatic external and email link decoration in MkDocs without manual markup—it requires minimal configuration and has low install friction.

Install

mkdocs-link-marker on PyPI

pip install mkdocs-link-marker

uv add mkdocs-link-marker

poetry add mkdocs-link-marker

Installing mkdocs-link-marker

Before you install

Low friction install as a pure Python wheel with only mkdocs and jinja2 as runtime dependencies. Repository is active with recent commits and no known security vulnerabilities.

License in practice

MIT license permits commercial and private use with minimal restrictions; you may use, modify, and distribute this package freely as long as you include the license notice.

Quickstart

pip install mkdocs-link-marker

Then add to mkdocs.yml:
plugins:
  - link-marker

Run: mkdocs build

Verify before relying

• Whether the plugin works with all current MkDocs versions or if there are known compatibility constraints.
• Whether custom icon support extends beyond external links and mail links to other link types.

Package facts

Evidence: mkdocs_link_marker-0.3.0-py3-none-any.whl

Keywords: mkdocs, link, external

Tags

More Text Processing packages