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
CHANGELOG
1.2.0
Clarified support for Python 3.8
Dropped support Python 2.7
1.1.2
Dropped support Python 3.4
1.1.1
Fix to work even after MKDocs 1.0
Dropped support Python 3.3
1.1.0
Embed distribution license in source code
Remove dependency on ‘pytest-pythonpath’
1.0.0
First stable release version
Support Python 3.3 or later
0.5.0
Support reST format in PyPI Web UI
Add dependency on pypandoc
0.4.0
Update status to Beta version
Add documentation about this plugin
Add a Makefile for tidy tasks
0.3.0
Update status to Alpha version
0.2.0
Implement plugin configuration
Add class files to mkdocssafetext
Add unittest files to tests
0.1.0
First planning version
Make temporary directory structure
Add requirement specifiers
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-1.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ca556288de41f684f4875988d19ba1f7d0633fad3192bfbe511afc53b91c013c |
|
MD5 | aabb9de1dca8e70c7232bedcba1ca173 |
|
BLAKE2b-256 | a9af99f0ef8664d34cf42679ea9251c12dc9ce6342fa848a38694e79eb24ed71 |
Hashes for mkdocs_safe_text_plugin-1.2.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1d08a4920df88702b0be24cd309e48b2e8b20c7ca3bdeaca416f3811b5508045 |
|
MD5 | ae3780661367c64d2173e50bb7df4c54 |
|
BLAKE2b-256 | 795f87db28b3ab421b898a2091ebe4dfb74f711b22f4f6fe01fd52fbb25e9137 |