https://github.com/timmeinerzhagen/mkdocs-link-marker
MkDocs plugin for marking links e.g. external ones or mails.
https://github.com/timmeinerzhagen/mkdocs-link-marker
links mail marking mkdocs url
Last synced: 7 days ago
JSON representation
MkDocs plugin for marking links e.g. external ones or mails.
- Host: GitHub
- URL: https://github.com/timmeinerzhagen/mkdocs-link-marker
- Owner: timmeinerzhagen
- License: mit
- Created: 2023-02-02T20:34:28.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-25T21:23:36.000Z (about 1 year ago)
- Last Synced: 2025-03-30T08:51:12.695Z (26 days ago)
- Topics: links, mail, marking, mkdocs, url
- Language: Python
- Homepage: https://pypi.org/project/mkdocs-link-marker/
- Size: 48.8 KB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mkdocs-link-marker
MkDocs plugin for marking external or mail links in your documentation.
## Setup
1. Install the plugin:
```bash
pip install mkdocs-link-marker
```
2. Add the plugin to your `mkdocs.yml`
```bash
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: ✉