Plugin for safe text editing with MKDocs.
Project description
Plugin for safe text editing with MKDocs.
Table of Contents
How does this plugin work?
Markdown is a very flexible format, and raw HTML is allowed. But it is unnecessary in multiple-person text editing.
When raw HTML like <font> tag is used in MKDocs, it is rendered as it is.
If you use this plug-in with MKDocs, tags that are not allowed in the whitelist are escaped.
Installation
Install it via PyPI using pip command.
$ pip install mkdocs-safe-text-plugin
And add it to your mkdocs.yml file.
plugins:
- mkdocs_safe_text
An example of use can be checked by example/basic-usage.
Plugin configuration
This plugin works with the HTML tag element for Markdown defined by bleach-whitelist enabled. This implementation approach is recommended in the Python-Markdown release notes.
And user can change this setting.
plugins:
- mkdocs_safe_text:
append_allowed_tags:
- tag1
- tag2
remove_allowed_tags:
- tag3
- tag4
allowed_attrs:
tag5:
- attribute1
- attribute2
An example of use can be checked by example/customization-usage.
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mkdocs-safe-text-plugin-0.4.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8bee014195dbf4c1d1c5b34757169201ab5fa1f7ce86a3e11d6475f0e1441a56 |
|
MD5 | fce97344127a775df52dcb74c8dbef5b |
|
BLAKE2b-256 | 054c2b4e47afae53fc958e9cfc7c9024e5f9ae0c5527e8b92f08b310e79d657e |
Hashes for mkdocs_safe_text_plugin-0.4.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d38b6e045810d003cb08ab0ccd631c9fcc5f419686eb57ec27448fbfcbb50628 |
|
MD5 | 3e5b563f03745327b360a3ef56615fba |
|
BLAKE2b-256 | ffd4d6d80cd44c0d121ab467d2d4372ed8dec3a6004d739f65832f433583ef36 |