GitHub-Flavored Markdown for Python
PLEASE READ BEFORE USING: This repository will not receive bug fixes, and might become read-only soon.
Rationale: this library has well-known consistency issues with GitHub-Flavored Markdown rendering. Fixing them would require time investment the maintainer cannot provide. The maintainer is also fatigued by Markdown’s library constantly breaking their internal API with each minor release.
Consider instead using pycmarkgfm (PyPi), a lightweight Python 3.5+ wrapper for GitHub’s own implementation of GFM from the same author, which is faster, virtually byte-compatible with GitHub rendering, and provides a nice API for managing task lists aka. TODO lists.
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.
Release files for py-gfm 2.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| py-gfm-2.0.0.linux-x86_64.tar.gz | 19.2 kB | Without provenance | Details for py-gfm-2.0.0.linux-x86_64.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| py_gfm-2.0.0-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details for py_gfm-2.0.0-py2.py3-none-any.whl |
Total release size: 35.4 kB
Release files / py-gfm-2.0.0.linux-x86_64.tar.gz
| Download URL | py-gfm-2.0.0.linux-x86_64.tar.gz |
|---|---|
| Size | 19.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8768b31bbfda8e1d52e2f32b363c138eedf52b1a81c06036b60ece576b2a652f
|
|
BLAKE2b-256 checksum How to use checksums |
293830d207abd8f8d7ffc66495f2329442c70727e381cadd472bb94b72e4d150
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.10.8
|
Release files / py_gfm-2.0.0-py2.py3-none-any.whl
| Download URL | py_gfm-2.0.0-py2.py3-none-any.whl |
|---|---|
| Size | 16.2 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
c49f43b584e15bdbe569141c92aefc00542289b6d88d95b38117e3359a35cdfe
|
|
BLAKE2b-256 checksum How to use checksums |
2d3b6d8adfd7ffbddcebea22cebd40679fee0332dbc85ec95e6179fefbaedfdd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.10.8
|
Security for py-gfm 2.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
