An implementation of Github-Flavored Markdown written as an extension to the Python Markdown library.
Project description
This is an implementation of GitHub-Flavored Markdown written as an extension to the Python Markdown library. It aims for, but does not achieve, maximal compatibility with GitHub’s rendering.
Tested Python versions are 3.5 to 3.8. Sorry, no Python 2.7 support starting with py-gfm 1.x since the Python Markdown library itself is Python 3 only.
Documentation
You can browse or download the precompiled documentation on Read the Docs.
To build the Sphinx documentation from source, use:
cd doc && make html
Supported features
Fenced code blocks
Literal line breaks
Tables
Hyperlink parsing (http, https, ftp, email and www subdomains)
Code highlighting for code blocks if Pygments is available
Mixed-style lists with no separation
Strikethrough
Task lists
Unsupported features and known differences
py-gfm is a pure Python implementation based on the Python Markdown library and therefore cannot reproduce GitHub’s own implementation with 100% accuracy.
See the docs for a list of known discrepancies.
License
BSD-style. See LICENSE.
Project details
Release history Release notifications | RSS feed
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
Hashes for py_gfm-1.0.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ee20aac38283eca9cc6b32eb7404b8d35c97d3c0b3d55abb22f08521b4094f46 |
|
MD5 | bed2bc02a50db33e70d597e075836a37 |
|
BLAKE2b-256 | e31cd3b9cec503ae1d18a98ab5e89e2db5ad33c7b423dc0051ab94caab9edf4f |