mkdocs-link-marker

Name	mkdocs-link-marker JSON
Version	0.1.3 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	2024-02-25 21:24:16
maintainer
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": "",
    "docs_url": null,
    "requires_python": ">=3.4",
    "maintainer_email": "",
    "keywords": "mkdocs link external",
    "author": "Tim Jonas Meinerzhagen",
    "author_email": "tim@meinerzhagen.me",
    "download_url": "https://files.pythonhosted.org/packages/c3/a3/5422a7c2a50c23c9de14b2df780bf3345eef9a06cbb1e123367b7d66cfc4/mkdocs-link-marker-0.1.3.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.1.3",
    "project_urls": {
        "Homepage": "https://github.com/timmeinerzhagen/mkdocs-link-marker"
    },
    "split_keywords": [
        "mkdocs",
        "link",
        "external"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "16dfe18f73f5be74ed5d4627d371a66c45d00be536923a591c6a0b5d29a06431",
                "md5": "e40fc09050ee1f1d6f55aed6df5aece6",
                "sha256": "798a6bfbb059ce49a81f724e84306bec8f1d5241aace89e54ae7d9088beeab5b"
            },
            "downloads": -1,
            "filename": "mkdocs_link_marker-0.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e40fc09050ee1f1d6f55aed6df5aece6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.4",
            "size": 2729,
            "upload_time": "2024-02-25T21:24:15",
            "upload_time_iso_8601": "2024-02-25T21:24:15.130761Z",
            "url": "https://files.pythonhosted.org/packages/16/df/e18f73f5be74ed5d4627d371a66c45d00be536923a591c6a0b5d29a06431/mkdocs_link_marker-0.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c3a35422a7c2a50c23c9de14b2df780bf3345eef9a06cbb1e123367b7d66cfc4",
                "md5": "e2d02d2165908056e9e6bf3de31962e0",
                "sha256": "6d8760c819a376650675f02c7de82f5fbc0a992e7ed3239955cc01021a1af779"
            },
            "downloads": -1,
            "filename": "mkdocs-link-marker-0.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "e2d02d2165908056e9e6bf3de31962e0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.4",
            "size": 2240,
            "upload_time": "2024-02-25T21:24:16",
            "upload_time_iso_8601": "2024-02-25T21:24:16.777652Z",
            "url": "https://files.pythonhosted.org/packages/c3/a3/5422a7c2a50c23c9de14b2df780bf3345eef9a06cbb1e123367b7d66cfc4/mkdocs-link-marker-0.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-25 21:24:16",
    "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"
}