Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rolfff/mkdocs-encriptmail-plugin
A MkDocs plugin that converts markdown encoded email-links into spambot save <a href> elements.
https://github.com/rolfff/mkdocs-encriptmail-plugin
email markdown mkdocs
Last synced: 2 days ago
JSON representation
A MkDocs plugin that converts markdown encoded email-links into spambot save <a href> elements.
- Host: GitHub
- URL: https://github.com/rolfff/mkdocs-encriptmail-plugin
- Owner: Rolfff
- License: mit
- Created: 2022-12-17T18:06:04.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2022-12-26T18:47:21.000Z (almost 2 years ago)
- Last Synced: 2024-09-25T21:04:14.848Z (2 days ago)
- Topics: email, markdown, mkdocs
- Language: Python
- Homepage: https://pypi.org/project/mkdocs-encriptmail-plugin/
- Size: 47.9 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MkDocs encriptMail Plugin
This [MkDocs](https://www.mkdocs.org) plugin converts markdown encoded email addresses like
```
[Email-Link](mailto:[email protected])
```
into
```html
Email-Link
```
or
```
[[email protected]](mailto:[email protected])
```
into
```html
test(Q)test(P)test
```
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/)