Skip to main content

Plugin for safe text editing with MKDocs.

Project description

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

Plugin for safe text editing with MKDocs.

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.

$ 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-allowlist 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.

CHANGELOG

1.3.0

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

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mkdocs-safe-text-plugin, version 1.3.0
Filename, size File type Python version Upload date Hashes
Filename, size mkdocs_safe_text_plugin-1.3.0-py3-none-any.whl (8.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size mkdocs-safe-text-plugin-1.3.0.tar.gz (6.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page