| Name | mkdocs-inline-svg-plugin JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | None |
| Summary | MkDocs plugin for inlining svg-href img tags |
| upload_time | 2024-04-16 21:04:40 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
mkdocs
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
> **NOTE:** this project is still WIP!
# mkdocs-inline-svg-plugin
[](https://pypi.org/project/mkdocs-inline-svg-plugin)
[](https://pypi.org/project/mkdocs-inline-svg-plugin)
-----
**Table of Contents**
- [Installation](#installation)
- [License](#license)
## Installation
```console
pip install mkdocs-inline-svg-plugin
```
## License
`mkdocs-inline-svg-plugin` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
## Usage
If you want to inline SVGs, that were put in `img` tags by the [kroki plugin](https://github.com/AVATEAM-IT-SYSTEMHAUS/mkdocs-kroki-plugin):
`mkdocs.yml`:
```yaml
plugins:
- kroki:
FencePrefix: ''
HttpMethod: 'POST'
DownloadImages: true
- inline-svg:
alt_name: Kroki
```
### Configuration
| Config value | What for |
|---|---|
| `alt_name` | default: `*`, that does not check the `img` `alt` property |
| `include_assets` | default: `False`, looks for `url(..)`, downloads the contents to `asset_dir` and replaces the url |
| `asset_dir` | default: `assets/` |
| `patch_style` | default: `False`, this feature is **EXPERIMENTAL** and not yet finished, needs an additional CSS |
## Test
Serve documentation:
```sh
hatch run docs:serve
```
Raw data
{
"_id": null,
"home_page": null,
"name": "mkdocs-inline-svg-plugin",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "MkDocs",
"author": null,
"author_email": "Oni Boni <oniboni@mailbox.org>",
"download_url": "https://files.pythonhosted.org/packages/78/aa/e71377c87297b7bbeb71f7ff7826f4e23183ddece807590b071e7c7bce60/mkdocs_inline_svg_plugin-0.1.3.tar.gz",
"platform": null,
"description": "> **NOTE:** this project is still WIP!\n\n# mkdocs-inline-svg-plugin\n\n[](https://pypi.org/project/mkdocs-inline-svg-plugin)\n[](https://pypi.org/project/mkdocs-inline-svg-plugin)\n\n-----\n\n**Table of Contents**\n\n- [Installation](#installation)\n- [License](#license)\n\n## Installation\n\n```console\npip install mkdocs-inline-svg-plugin\n```\n\n## License\n\n`mkdocs-inline-svg-plugin` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.\n\n## Usage\n\nIf you want to inline SVGs, that were put in `img` tags by the [kroki plugin](https://github.com/AVATEAM-IT-SYSTEMHAUS/mkdocs-kroki-plugin):\n\n`mkdocs.yml`:\n```yaml\nplugins:\n - kroki:\n FencePrefix: ''\n HttpMethod: 'POST'\n DownloadImages: true\n - inline-svg:\n alt_name: Kroki\n```\n\n### Configuration\n\n| Config value | What for |\n|---|---|\n| `alt_name` | default: `*`, that does not check the `img` `alt` property |\n| `include_assets` | default: `False`, looks for `url(..)`, downloads the contents to `asset_dir` and replaces the url |\n| `asset_dir` | default: `assets/` |\n| `patch_style` | default: `False`, this feature is **EXPERIMENTAL** and not yet finished, needs an additional CSS |\n\n## Test\n\nServe documentation:\n```sh\nhatch run docs:serve\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "MkDocs plugin for inlining svg-href img tags",
"version": "0.1.3",
"project_urls": {
"Documentation": "https://github.com/oniboni/mkdocs-inline-svg-plugin#readme",
"Issues": "https://github.com/oniboni/mkdocs-inline-svg-plugin/issues",
"Source": "https://github.com/oniboni/mkdocs-inline-svg-plugin"
},
"split_keywords": [
"mkdocs"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c0bf9460bf4f8881725a7e5cf02ec2fd883a2daa92e049c8aad6c08d5a6f7b85",
"md5": "3a331539f42394974489f17d682077d1",
"sha256": "c18875914b0d05145ebe48dfacc28627f039db16a305c5907b4b6efefe6f22eb"
},
"downloads": -1,
"filename": "mkdocs_inline_svg_plugin-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3a331539f42394974489f17d682077d1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6782,
"upload_time": "2024-04-16T21:04:41",
"upload_time_iso_8601": "2024-04-16T21:04:41.595904Z",
"url": "https://files.pythonhosted.org/packages/c0/bf/9460bf4f8881725a7e5cf02ec2fd883a2daa92e049c8aad6c08d5a6f7b85/mkdocs_inline_svg_plugin-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "78aae71377c87297b7bbeb71f7ff7826f4e23183ddece807590b071e7c7bce60",
"md5": "5a127fd4f5bbb737bf265780b333d225",
"sha256": "c12c74be9d23304b96012b86bcf60ac31f43071e4d4a69138decce6da956bfab"
},
"downloads": -1,
"filename": "mkdocs_inline_svg_plugin-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "5a127fd4f5bbb737bf265780b333d225",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 10089,
"upload_time": "2024-04-16T21:04:40",
"upload_time_iso_8601": "2024-04-16T21:04:40.232802Z",
"url": "https://files.pythonhosted.org/packages/78/aa/e71377c87297b7bbeb71f7ff7826f4e23183ddece807590b071e7c7bce60/mkdocs_inline_svg_plugin-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-16 21:04:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "oniboni",
"github_project": "mkdocs-inline-svg-plugin#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mkdocs-inline-svg-plugin"
}
