# MkDocs encriptMail Plugin
This [MkDocs](https://www.mkdocs.org) plugin converts markdown encoded email addresses like
```
[Email-Link](mailto:test@test.test)
```
into
```html
<a href="javascript:linkTo_UnCryptMailto(%27ocknvq,vguvBvguv0vguv%27)">
Email-Link
</a>
```
or
```
[test@test.test](mailto:test@test.test)
```
into
```html
<a href="javascript:linkTo_UnCryptMailto(%27ocknvq,vguvBvguv0vguv%27)">
test(Q)test(P)test
</a>
```
This allows to hide email address from spam bots and allows user to link email addresses.
## Requirements
This package requires Python >=3.5 and MkDocs version 1.0 or higher.
## Installation
Install the package with pip:
```cmd
pip install mkdocs-encriptmail-plugin
```
Enable the plugin in your `mkdocs.yml`:
```yaml
plugins:
- search
- encriptmail:
placeholderAt: (Q)
placeholderDot: (P)
```
**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](https://www.mkdocs.org/user-guide/plugins/)
Raw data
{
"_id": null,
"home_page": "https://github.com/Rolfff/mkdocs-encriptmail-plugin",
"name": "mkdocs-encriptmail-plugin",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": "",
"keywords": "mkdocs python markdown",
"author": "Rolfff",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/5f/61/ee6502a4e51096e3e6d1028eeadce864360d4ff96cf5439504d793704611/mkdocs-encriptmail-plugin-0.9.8.tar.gz",
"platform": null,
"description": "# MkDocs encriptMail Plugin\n\nThis [MkDocs](https://www.mkdocs.org) plugin converts markdown encoded email addresses like\n\n```\n[Email-Link](mailto:test@test.test)\n```\n\ninto \n\n```html\n<a href=\"javascript:linkTo_UnCryptMailto(%27ocknvq,vguvBvguv0vguv%27)\">\n Email-Link\n</a>\n```\n\nor\n\n```\n[test@test.test](mailto:test@test.test)\n```\n\ninto \n\n```html\n<a href=\"javascript:linkTo_UnCryptMailto(%27ocknvq,vguvBvguv0vguv%27)\">\n test(Q)test(P)test\n</a>\n```\n\nThis allows to hide email address from spam bots and allows user to link email addresses.\n\n## Requirements\n\nThis package requires Python >=3.5 and MkDocs version 1.0 or higher. \n\n## Installation\n\nInstall the package with pip:\n\n```cmd\npip install mkdocs-encriptmail-plugin\n```\n\nEnable the plugin in your `mkdocs.yml`:\n\n```yaml\nplugins:\n - search\n - encriptmail:\n placeholderAt: (Q)\n placeholderDot: (P)\n```\n\n**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.\n\nMore information about plugins in the [MkDocs documentation](https://www.mkdocs.org/user-guide/plugins/)",
"bugtrack_url": null,
"license": "MIT",
"summary": "A MkDocs plugin that converts markdown encoded email-links into spambot save <a href> elements.",
"version": "0.9.8",
"split_keywords": [
"mkdocs",
"python",
"markdown"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "0b5079c313ac8ac925c4a112cc7f94a5",
"sha256": "ccd307fa3bc524d5c7549b3bc82a5821452946d8c3870644bf68b6f39ba7bbe2"
},
"downloads": -1,
"filename": "mkdocs-encriptmail-plugin-0.9.8.tar.gz",
"has_sig": false,
"md5_digest": "0b5079c313ac8ac925c4a112cc7f94a5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 6680,
"upload_time": "2022-12-26T17:26:50",
"upload_time_iso_8601": "2022-12-26T17:26:50.812063Z",
"url": "https://files.pythonhosted.org/packages/5f/61/ee6502a4e51096e3e6d1028eeadce864360d4ff96cf5439504d793704611/mkdocs-encriptmail-plugin-0.9.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-26 17:26:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Rolfff",
"github_project": "mkdocs-encriptmail-plugin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mkdocs-encriptmail-plugin"
}
JSON
