mkdocs-link-marker
MkDocs plugin for marking external or mail links in your documentation.
Decision gist · record as of 2026-08-14
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.AI-flagged interpretation of the facts on this page — verify before relying
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 · maintenance · safety
MIT (permissive) — 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.
last release 2026-03-04 (163 days) · last repo commit 2026-03-04 · 9 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 1,002,188 downloads/mo, #4,534 on PyPI
Alternatives
Verify before relying
pip install mkdocs-link-marker
Then add to mkdocs.yml:
plugins:
- link-marker
Run: mkdocs build- 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.
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 on it.
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
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 buildVerify 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
| License | MIT permissive |
| Python support | Supports the current Python release >=3.4 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 2 packagesmkdocsjinja2 |
| Maintenance | Actively maintained 163 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 1,002,188 / month, #4,534 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | License :: OSI Approved :: MIT LicenseOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3Programming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.7Programming Language :: Python :: 3.8Programming Language :: Python :: 3.9Topic :: DocumentationTopic :: Text Processing |
Evidence: mkdocs_link_marker-0.3.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “mkdocs external link icon”
- mkdocs-link-markerA MkDocs plugin that automatically marks external links and email…
- mkdocs-htmlproofer-pluginA MkDocs plugin that validates URLs and anchors in rendered HTML…
- mkdocs-open-in-new-tabA MkDocs plugin that injects JavaScript to automatically open…
Give your agent the search over MCP, or paste the wish link into any chat.
More Text Processing packages
A drop-in replacement for Python's standard `re` module that adds advanced regex features like nested sets, fuzzy matching, lookaround in conditionals, and full Unicode case-folding while maintaining backward compatibility.
pyparsing provides a library for building text parsers directly in Python code using composable grammar classes, handling quoted strings, whitespace variation, and embedded comments without regex or lex/yacc.
Install it if you need to parse text or define grammars programmatically.
fonttools manipulates font files in multiple formats (TrueType, OpenType, AFM, Type 1, Mac-specific) and includes TTX, a tool to convert fonts to and from XML text format.
Install it if you need to read, write, or manipulate fonts programmatically or via the TTX command-line tool.
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
RapidFuzz provides fast fuzzy string matching using Levenshtein Distance and related metrics, implemented mostly in C++ with Python bindings for rapid similarity scoring and approximate string matching.
Install it if you need fuzzy string matching; it's a solid replacement for FuzzyWuzzy with better licensing and performance.
tinycss2 parses CSS strings into token and block objects, and generates CSS strings from those objects, following the CSS Syntax Level 3 specification without enforcing specific properties or values.
Install it if your project requires CSS tokenization or syntax manipulation.
See also mkdocs-open-in-new-tab · mkdocs-video · mkdocs-meta-manager · mkdocs-simple-hooks · mkdocs-material-extensions · mkdocs-macros-plugin · mkdocs-task-collector · mkdocs-git-revision-date-plugin · mkdocs-get-deps · mkdocs-plugin-inline-svg