mkdocs-link-marker

Name	mkdocs-link-marker JSON
Version	0.2.0 JSON
	download
home_page	https://github.com/timmeinerzhagen/mkdocs-link-marker
Summary	MkDocs plugin for marking external or mail links in your documentation.
upload_time	2025-07-20 20:59:01
maintainer	None
docs_url	None
author	Tim Jonas Meinerzhagen
requires_python	>=3.4
license	MIT
keywords	mkdocs link external
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # mkdocs-link-marker

MkDocs plugin for marking external or mail links in your documentation.

![comparison](https://raw.githubusercontent.com/timmeinerzhagen/mkdocs-link-marker/main/docs/comparison.png)
## 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: ✉

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/timmeinerzhagen/mkdocs-link-marker",
    "name": "mkdocs-link-marker",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.4",
    "maintainer_email": null,
    "keywords": "mkdocs link external",
    "author": "Tim Jonas Meinerzhagen",
    "author_email": "tim@meinerzhagen.me",
    "download_url": "https://files.pythonhosted.org/packages/98/a9/472488b460eaeac65816af9b4de221441411d225879c3109e410259b98ea/mkdocs_link_marker-0.2.0.tar.gz",
    "platform": null,
    "description": "# mkdocs-link-marker\n\nMkDocs plugin for marking external or mail links in your documentation.\n\n![comparison](https://raw.githubusercontent.com/timmeinerzhagen/mkdocs-link-marker/main/docs/comparison.png)\n## Setup\n\n1. Install the plugin:\n    ```bash\n    pip install mkdocs-link-marker\n    ```\n2. Add the plugin to your `mkdocs.yml`\n    ```bash\n    plugins:\n        - search\n        - link-marker\n    ```\n\n## Usage\n\nRun the build!\n\n## Options\n\n`enable_external_link`\nWhether to mark external links with the according icon.\nDefault: True\n\n`icon_external_link`\nChange the default icon for marking external links.\nDefault: \u29c9\n\n`enable_mail`\nWhether to mark mail links with the according icon.\nDefault: True\n\n`icon_mail`\nChange the default icon for marking mail links.\nDefault: \u2709\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "MkDocs plugin for marking external or mail links in your documentation.",
    "version": "0.2.0",
    "project_urls": {
        "Homepage": "https://github.com/timmeinerzhagen/mkdocs-link-marker"
    },
    "split_keywords": [
        "mkdocs",
        "link",
        "external"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "be1283d4a1304c70537d9ec16c752be2eaf32d2b7876c5a1b11649cce703c1ab",
                "md5": "b8ffa562d1718602ced797a584d301ed",
                "sha256": "1a6b92b3bc67349d8d49eb18278a4ad9e1a9c0037f4dcc76bbb9e4aaf969539d"
            },
            "downloads": -1,
            "filename": "mkdocs_link_marker-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b8ffa562d1718602ced797a584d301ed",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.4",
            "size": 2936,
            "upload_time": "2025-07-20T20:59:00",
            "upload_time_iso_8601": "2025-07-20T20:59:00.696071Z",
            "url": "https://files.pythonhosted.org/packages/be/12/83d4a1304c70537d9ec16c752be2eaf32d2b7876c5a1b11649cce703c1ab/mkdocs_link_marker-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "98a9472488b460eaeac65816af9b4de221441411d225879c3109e410259b98ea",
                "md5": "bb4505ce88ec2b87168a308c4cab3b6a",
                "sha256": "8d194fd1666368ecf588f942bcc920071723776ef777961c72b7dc16da7c41a5"
            },
            "downloads": -1,
            "filename": "mkdocs_link_marker-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "bb4505ce88ec2b87168a308c4cab3b6a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.4",
            "size": 2452,
            "upload_time": "2025-07-20T20:59:01",
            "upload_time_iso_8601": "2025-07-20T20:59:01.752572Z",
            "url": "https://files.pythonhosted.org/packages/98/a9/472488b460eaeac65816af9b4de221441411d225879c3109e410259b98ea/mkdocs_link_marker-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-20 20:59:01",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "timmeinerzhagen",
    "github_project": "mkdocs-link-marker",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mkdocs-link-marker"
}