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.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.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size mkdocs_safe_text_plugin-1.0.0-py2.py3-none-any.whl (8.0 kB) | File type Wheel | Python version py2.py3 | Upload date | Hashes View |
Filename, size mkdocs-safe-text-plugin-1.0.0.tar.gz (5.5 kB) | File type Source | Python version None | Upload date | Hashes View |
Hashes for mkdocs_safe_text_plugin-1.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 36af04d3c0ecae974c024395630f4ff4a0db6297d54183470752cbf4b214be15 |
|
MD5 | 83ea3ef7885df8b3efa24d8109a0ae9e |
|
BLAKE2-256 | 99f1c791cb53a636a856ace38b16829cfe1fa1a2efcbdeb5c365505013460d37 |
Hashes for mkdocs-safe-text-plugin-1.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9c6788ab24c297f05a35affb32ff0c8e9c8974c9f9269df1f51ca06a6a87d991 |
|
MD5 | c5b26bcfece7ff2f9bbb8df58c2631a0 |
|
BLAKE2-256 | 711bd81823460f5bb015a1fc2d6829711244500ea36e02cc84b4ce690171b11f |