Skip to main content

An implementation of Github-Flavored Markdown written as an extension to the Python Markdown library.

Project description

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.

Build status Coverage status Documentation Status

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

py-gfm-2.0.0.linux-x86_64.tar.gz (19.2 kB view details)

Uploaded Source

Built Distribution

py_gfm-2.0.0-py2.py3-none-any.whl (16.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file py-gfm-2.0.0.linux-x86_64.tar.gz.

File metadata

  • Download URL: py-gfm-2.0.0.linux-x86_64.tar.gz
  • Upload date:
  • Size: 19.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.8

File hashes

Hashes for py-gfm-2.0.0.linux-x86_64.tar.gz
Algorithm Hash digest
SHA256 8768b31bbfda8e1d52e2f32b363c138eedf52b1a81c06036b60ece576b2a652f
MD5 ae356876453ea63185e46ddac9cc0099
BLAKE2b-256 293830d207abd8f8d7ffc66495f2329442c70727e381cadd472bb94b72e4d150

See more details on using hashes here.

File details

Details for the file py_gfm-2.0.0-py2.py3-none-any.whl.

File metadata

  • Download URL: py_gfm-2.0.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 16.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.8

File hashes

Hashes for py_gfm-2.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c49f43b584e15bdbe569141c92aefc00542289b6d88d95b38117e3359a35cdfe
MD5 55795a1bbcfc5bff7d1351dcf745aa4b
BLAKE2b-256 2d3b6d8adfd7ffbddcebea22cebd40679fee0332dbc85ec95e6179fefbaedfdd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page