MkDocs plugin for marking external or mail links in your documentation.
Project description
mkdocs-link-marker
MkDocs plugin for marking external or mail links in your documentation.
Setup
- Install the plugin:
pip install mkdocs-link-marker
- Add the plugin to your
mkdocs.ymlplugins: - 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: ✉
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file mkdocs-link-marker-0.1.2.tar.gz.
File metadata
- Download URL: mkdocs-link-marker-0.1.2.tar.gz
- Upload date:
- Size: 2.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 25c7056bbad6ffd409f06edf19c746c029bba222df28b93cc9b0eec77ad60653 |
|
| MD5 | 8c73134c08c4ce5e125a8a6a3b19c703 |
|
| BLAKE2b-256 | e49baf594cfae5b3b8525dac68cea2471e3b26571d51626d57318f9909b086a9 |
File details
Details for the file mkdocs_link_marker-0.1.2-py3-none-any.whl.
File metadata
- Download URL: mkdocs_link_marker-0.1.2-py3-none-any.whl
- Upload date:
- Size: 2.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 42ebefb61a0225c1ca0884a8799cfe6973f853593603244b9040da2d3d78ae6f |
|
| MD5 | 679895359adc5af06133c2763d09cfa7 |
|
| BLAKE2b-256 | ff58bc16349bc88bf74f7e2c102168169ad86a6d84575e8b5d436a16a4584db4 |
