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.
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
Close
Hashes for mkdocs-safe-text-plugin-0.4.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 16adc7deeac2dee7b53fb72e20ee1dda7980ec4452e430dcacb423c01cf5a308 |
|
MD5 | d6e9200ebafe610fffdabe14c76aec6c |
|
BLAKE2b-256 | bf7d22e603045260a92cb4b481a12e4b4f51dfff521e20c0accffeeda4bf5941 |
Close
Hashes for mkdocs_safe_text_plugin-0.4.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 650895de37a9bf90a8acf54341637fd36803bdb481eefd36b8cdd9bbf8c27f8f |
|
MD5 | a6c40ab630288e726922cd8123bc83ff |
|
BLAKE2b-256 | 843ecacc40c3127069926b1711a977c184911b82534d8c4cbf9cc79d9f4572d1 |