Python-Markdown extension for easy changelog tagging
Project description
Markdown-changelog
Markdown extension to enable easy addition of changelog badges to your documentation
Installation
The easiest way to install markdown-changelog
is to use pip
pip install markdown-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=["markdown_changelog.changelog"])
md.convert(text)
'<p><span class="badge badge-fix">Fix</span></p>'
# or
from markdown_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;;)
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for markdown_changelog-0.0.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 72a87738b940277e3327efe63973ae7223a6e8edd5263b291f9aaaeb36336dcd |
|
MD5 | 0c7f52445354220d4be567ecbac0e590 |
|
BLAKE2b-256 | e1cf85e5b7ba7a3d1ae8b40a95a6c780c84c01044b814042634cecbc352d37e9 |