mkdocs-safe-text-plugin

mkdocs-safe-text-plugin

|Build Status| |PyPI - Python Version| |PyPI version| |GitHub Release| |Codecov| |BSD License|

Plugin for safe text editing with MKDocs <http://www.mkdocs.org/>__.

Table of Contents

• How does this plugin work? <#how-does-this-plugin-work>__
• Installation <#installation>__
• Plugin configuration <#plugin-configuration>__
• License <#license>__

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.

|No escaped font|

If you use this plug-in with MKDocs, tags that are not allowed in the allowlist are escaped.

|Escaped font|

Installation

Install it via PyPI using pip command.

.. code:: console

$ pip install mkdocs-safe-text-plugin

And add it to your mkdocs.yml file.

.. code:: yaml

plugins: - mkdocs_safe_text

An example of use can be checked by example/basic-usage <https://github.com/raimon49/mkdocs-safe-text-plugin/tree/master/examples/basic-usage>__.

Plugin configuration

This plugin works with the HTML tag element for Markdown defined by bleach-allowlist <https://github.com/yourcelf/bleach-allowlist/blob/main/bleach_allowlist/bleach_allowlist.py>__ enabled. This implementation approach is recommended in the Python-Markdown release notes <https://python-markdown.github.io/change_log/release-2.6/>__.

And user can change this setting.

.. code:: yaml

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 <https://github.com/raimon49/mkdocs-safe-text-plugin/tree/master/examples/customization-usage>__.

License

BSD 2-Clause License <https://github.com/raimon49/mkdocs-safe-text-plugin/blob/master/LICENSE>__

.. |Build Status| image:: https://github.com/raimon49/mkdocs-safe-text-plugin/workflows/Python%20package/badge.svg :target: https://github.com/raimon49/mkdocs-safe-text-plugin/actions?query=workflow%3A%22Python+package%22 .. |PyPI - Python Version| image:: https://img.shields.io/pypi/pyversions/mkdocs-safe-text-plugin.svg :target: https://pypi.org/project/mkdocs-safe-text-plugin/ .. |PyPI version| image:: https://badge.fury.io/py/mkdocs-safe-text-plugin.svg :target: https://badge.fury.io/py/mkdocs-safe-text-plugin .. |GitHub Release| image:: https://img.shields.io/github/release/raimon49/mkdocs-safe-text-plugin.svg :target: https://github.com/raimon49/mkdocs-safe-text-plugin/releases .. |Codecov| image:: https://codecov.io/gh/raimon49/mkdocs-safe-text-plugin/branch/master/graph/badge.svg :target: https://codecov.io/gh/raimon49/mkdocs-safe-text-plugin .. |BSD License| image:: http://img.shields.io/badge/license-BSD-green.svg :target: https://github.com/raimon49/mkdocs-safe-text-plugin/blob/master/LICENSE .. |No escaped font| image:: https://user-images.githubusercontent.com/221802/35481481-ac9e4894-0467-11e8-89ab-47ca5037d9d2.png .. |Escaped font| image:: https://user-images.githubusercontent.com/221802/35481484-b268e02c-0467-11e8-8b7a-c3c7232312ed.png

CHANGELOG

.. _151:

1.5.1

-  Clarified support for Python 3.11(fix metadata)

.. _150:

1.5.0

• Clarified support for Python 3.11

.. _140:

1.4.0

-  Clarified support for Python 3.10
-  Dropped support Python 3.6

.. _131:

1.3.1

• Requires bleach-allowlist version 1.0.3 or higher

.. _130:

1.3.0

-  Migrate using Python package from ``bleach-whitelist`` to
   ``bleach-allowlist``
-  Clarified support for Python 3.9
-  Dropped support Python 3.5

.. _120:

1.2.0

• Clarified support for Python 3.8
• Dropped support Python 2.7

.. _112:

1.1.2

-  Dropped support Python 3.4

.. _111:

1.1.1

• Fix to work even after MKDocs 1.0
• Dropped support Python 3.3

.. _110:

1.1.0

-  Embed distribution license in source code
-  Remove dependency on 'pytest-pythonpath'

.. _100:

1.0.0

• First stable release version

  • Support Python 3.3 or later

.. _050:

0.5.0

-  Support reST format in PyPI Web UI

   -  Add dependency on pypandoc

.. _040:

0.4.0

• Update status to Beta version

  • Add documentation about this plugin
  • Add a Makefile for tidy tasks

.. _030:

0.3.0

-  Update status to Alpha version

.. _020:

0.2.0

• Implement plugin configuration

  • Add class files to mkdocssafetext
  • Add unittest files to tests

.. _010:

0.1.0

-  First planning version

   -  Make temporary directory structure
   -  Add requirement specifiers