markdown-changelog 0.0.1

Python-Markdown extension for easy changelog tagging

mdx-changelog

Markdown extension to enable easy addition of changelog badges to your documentation

Installation

The easiest way to install Mdx-Changelog is to use pip

pip install mdx-changelog

Usage

import markdown

text = """;;fix;;"""
md = markdown.Markdown(extensions=["changelog"])
md.convert(text)
'<p><span class="badge badge-fix">Fix</span></p>'

# or
md = markdown.Markdown(extensions=["mdx_changelog.changelog"])
md.convert(text)
'<p><span class="badge badge-fix">Fix</span></p>'

# or 
from mdx_changelog import ChangelogExtension
md = markdown.Markdown(extensions=[ChangelogExtension()])

md.convert(text)
'<p><span class="badge badge-fix">Fix</span></p>'

Supported tags

The following tags are supported by default:

• ;;fix;;
• ;;change;; (or ;;changes;;, ;;changed;;)
• ;;improvement;; (or ;;improvements;;, ;;enhancement;;, ;;enhancements;;)
• ;;new;; (or ;;feature;;)
• ;;efficiency;;
• ;;docs;; (or ;;documentation;;)