mkdocs-plugin-inline-svg-utf8

Name	mkdocs-plugin-inline-svg-utf8 JSON
Version	0.1.3 JSON
	download
home_page	https://github.com/Grufbert/mkdocs-plugin-inline-svg-utf8
Summary	A MkDocs plugin that inlines SVG images into the output with utf-8 encoding.
upload_time	2024-09-06 21:13:16
maintainer	None
docs_url	None
author	Nico Klinger
requires_python	>=3.5
license	MIT
keywords	mkdocs plugin inline svg utf8
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # mkdocs-plugin-inline-svg-utf8

Extend the plugin from craig0990 to read UTF-8 encoded files

> Reads SVG images referenced from Markdown and replaces them with the SVG
> file content

Since the SVG is included as part of the plain-text input to MkDocs, this means
the default MkDocs search supports searching SVG text, and hyperlinks are also
fully functional.

## Usage

Install the package with pip:

`pip install mkdocs-plugin-inline-svg-utf8`

Enable the plugin in your mkdocs.yml:

```
plugins:
    - search
    - inline-svg-utf8
```

> Note: If you have no plugins entry in your config file yet, you'll likely
> also want to add the search plugin. MkDocs enables it by default if there is
> no plugins entry set, but now you have to enable it explicitly.

More information about plugins in the MkDocs documentation

## Credits

* https://gitlab.com/craig0990/mkdocs-plugin-inline-svg

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Grufbert/mkdocs-plugin-inline-svg-utf8",
    "name": "mkdocs-plugin-inline-svg-utf8",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.5",
    "maintainer_email": null,
    "keywords": "mkdocs plugin inline svg utf8",
    "author": "Nico Klinger",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/ea/e3/a431054183415938583f2508232a660a64b92242be09add1e7582eb0cf31/mkdocs_plugin_inline_svg_utf8-0.1.3.tar.gz",
    "platform": null,
    "description": "# mkdocs-plugin-inline-svg-utf8\n\nExtend the plugin from craig0990 to read UTF-8 encoded files\n\n> Reads SVG images referenced from Markdown and replaces them with the SVG\n> file content\n\nSince the SVG is included as part of the plain-text input to MkDocs, this means\nthe default MkDocs search supports searching SVG text, and hyperlinks are also\nfully functional.\n\n## Usage\n\nInstall the package with pip:\n\n`pip install mkdocs-plugin-inline-svg-utf8`\n\nEnable the plugin in your mkdocs.yml:\n\n```\nplugins:\n    - search\n    - inline-svg-utf8\n```\n\n> Note: If you have no plugins entry in your config file yet, you'll likely\n> also want to add the search plugin. MkDocs enables it by default if there is\n> no plugins entry set, but now you have to enable it explicitly.\n\nMore information about plugins in the MkDocs documentation\n\n## Credits\n\n* https://gitlab.com/craig0990/mkdocs-plugin-inline-svg\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A MkDocs plugin that inlines SVG images into the output with utf-8 encoding.",
    "version": "0.1.3",
    "project_urls": {
        "Homepage": "https://github.com/Grufbert/mkdocs-plugin-inline-svg-utf8"
    },
    "split_keywords": [
        "mkdocs",
        "plugin",
        "inline",
        "svg",
        "utf8"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "12b473ea7822f5f430ee370bfa9e4be9d979bde60555503646270ef1996053a2",
                "md5": "b81731998f4cdfaca9c2f0d3df757ab8",
                "sha256": "e3c1070d50a96b2ecfe52f4310a481e8349eea0b7eea5f1036ae783c1e8b4963"
            },
            "downloads": -1,
            "filename": "mkdocs_plugin_inline_svg_utf8-0.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b81731998f4cdfaca9c2f0d3df757ab8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.5",
            "size": 3721,
            "upload_time": "2024-09-06T21:13:15",
            "upload_time_iso_8601": "2024-09-06T21:13:15.622140Z",
            "url": "https://files.pythonhosted.org/packages/12/b4/73ea7822f5f430ee370bfa9e4be9d979bde60555503646270ef1996053a2/mkdocs_plugin_inline_svg_utf8-0.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "eae3a431054183415938583f2508232a660a64b92242be09add1e7582eb0cf31",
                "md5": "f6741eff7d293580cdea18a78474cc28",
                "sha256": "e90d4b9829382a7461634c4bfb99ddf9fc711efbd5d06e8c40bd363f213799e6"
            },
            "downloads": -1,
            "filename": "mkdocs_plugin_inline_svg_utf8-0.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "f6741eff7d293580cdea18a78474cc28",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.5",
            "size": 2897,
            "upload_time": "2024-09-06T21:13:16",
            "upload_time_iso_8601": "2024-09-06T21:13:16.899326Z",
            "url": "https://files.pythonhosted.org/packages/ea/e3/a431054183415938583f2508232a660a64b92242be09add1e7582eb0cf31/mkdocs_plugin_inline_svg_utf8-0.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-06 21:13:16",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Grufbert",
    "github_project": "mkdocs-plugin-inline-svg-utf8",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mkdocs-plugin-inline-svg-utf8"
}