{"id":28355864,"url":"https://github.com/raimon49/mkdocs-safe-text-plugin","last_synced_at":"2025-07-17T20:41:32.906Z","repository":{"id":43417394,"uuid":"118235762","full_name":"raimon49/mkdocs-safe-text-plugin","owner":"raimon49","description":"Plugin for safe text editing with MKDocs.","archived":false,"fork":false,"pushed_at":"2024-09-04T00:30:43.000Z","size":130,"stargazers_count":4,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-04T11:24:23.213Z","etag":null,"topics":["markdown","mkdocs","plugin","xss"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/raimon49.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-01-20T11:15:30.000Z","updated_at":"2024-12-10T05:43:30.000Z","dependencies_parsed_at":"2024-11-16T17:41:58.973Z","dependency_job_id":"9832718d-cf56-4637-aa30-24880d4996a8","html_url":"https://github.com/raimon49/mkdocs-safe-text-plugin","commit_stats":{"total_commits":176,"total_committers":2,"mean_commits":88.0,"dds":0.005681818181818232,"last_synced_commit":"7644830a604487634a86cc140ad82413400d1548"},"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/raimon49/mkdocs-safe-text-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raimon49%2Fmkdocs-safe-text-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raimon49%2Fmkdocs-safe-text-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raimon49%2Fmkdocs-safe-text-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raimon49%2Fmkdocs-safe-text-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/raimon49","download_url":"https://codeload.github.com/raimon49/mkdocs-safe-text-plugin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raimon49%2Fmkdocs-safe-text-plugin/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260865114,"owners_count":23074569,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["markdown","mkdocs","plugin","xss"],"created_at":"2025-05-28T06:00:47.218Z","updated_at":"2025-07-17T20:41:32.895Z","avatar_url":"https://github.com/raimon49.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mkdocs-safe-text-plugin\n\n[![Build Status](https://github.com/raimon49/mkdocs-safe-text-plugin/workflows/Python%20package/badge.svg)](https://github.com/raimon49/mkdocs-safe-text-plugin/actions?query=workflow%3A%22Python+package%22) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mkdocs-safe-text-plugin.svg)](https://pypi.org/project/mkdocs-safe-text-plugin/) [![PyPI version](https://badge.fury.io/py/mkdocs-safe-text-plugin.svg)](https://badge.fury.io/py/mkdocs-safe-text-plugin) [![GitHub Release](https://img.shields.io/github/release/raimon49/mkdocs-safe-text-plugin.svg)](https://github.com/raimon49/mkdocs-safe-text-plugin/releases) [![Codecov](https://codecov.io/gh/raimon49/mkdocs-safe-text-plugin/branch/master/graph/badge.svg)](https://codecov.io/gh/raimon49/mkdocs-safe-text-plugin) [![BSD License](http://img.shields.io/badge/license-BSD-green.svg)](https://github.com/raimon49/mkdocs-safe-text-plugin/blob/master/LICENSE)\n\nPlugin for safe text editing with [MKDocs](http://www.mkdocs.org/).\n\n## Table of Contents\n\n * [How does this plugin work?](#how-does-this-plugin-work)\n * [Installation](#installation)\n * [Plugin configuration](#plugin-configuration)\n * [License](#license)\n\n## How does this plugin work?\n\nMarkdown is a very flexible format, and raw HTML is allowed. But it is unnecessary in multiple-person text editing.\n\nWhen raw HTML like `\u003cfont\u003e` tag is used in MKDocs, it is rendered as it is.\n\n![No escaped font](https://user-images.githubusercontent.com/221802/35481481-ac9e4894-0467-11e8-89ab-47ca5037d9d2.png)\n\nIf you use this plug-in with MKDocs, tags that are not allowed in the allowlist are escaped.\n\n![Escaped font](https://user-images.githubusercontent.com/221802/35481484-b268e02c-0467-11e8-8b7a-c3c7232312ed.png)\n\n## Installation\n\nInstall it via PyPI using `pip` command.\n\n```console\n$ pip install mkdocs-safe-text-plugin\n```\n\nAnd add it to your `mkdocs.yml` file.\n\n```yaml\nplugins:\n  - mkdocs_safe_text\n```\n\nAn example of use can be checked by [example/basic-usage](https://github.com/raimon49/mkdocs-safe-text-plugin/tree/master/examples/basic-usage).\n\n## Plugin configuration\n\nThis 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/).\n\nAnd user can change this setting.\n\n```yaml\nplugins:\n  - mkdocs_safe_text:\n      append_allowed_tags:\n        - tag1\n        - tag2\n      remove_allowed_tags:\n        - tag3\n        - tag4\n      allowed_attrs:\n        tag5:\n          - attribute1\n          - attribute2\n```\n\nAn example of use can be checked by [example/customization-usage](https://github.com/raimon49/mkdocs-safe-text-plugin/tree/master/examples/customization-usage).\n\n## License\n\n[BSD 2-Clause License](https://github.com/raimon49/mkdocs-safe-text-plugin/blob/master/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraimon49%2Fmkdocs-safe-text-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fraimon49%2Fmkdocs-safe-text-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraimon49%2Fmkdocs-safe-text-plugin/lists"}