Skip to main content

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

Project description

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 maximal compatibility with GitHub’s rendering.


Sphinx documentation is in the doc/ folder. Build it with:

cd doc && make html

You can browse or download the precompiled documentation on Read the Docs.

Supported features

  • Fenced code blocks
  • Literal line breaks
  • Tables
  • Hyperlink parsing (http, https, ftp, email and www subdomains)
  • Code highlighting (dummy, no actual syntactic coloration as-is)
  • Mixed-style lists with no separation
  • Links and images with whitespace
  • Strikethrough
  • Task lists

Unsupported features

This implementation does not support all of GFM features.

Unsupported by design

  • Link to commits, issues, pull requests and user profiles: this is application specific. Feel free to subclass the provided classes to implement your own logic.

Unsupported, but planned

  • Horizontal rules
  • Emojis


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.

Filename, size & hash SHA256 hash help File type Python version Upload date
py_gfm-0.1.3-py2.py3-none-any.whl (13.9 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Jun 1, 2016
py-gfm-0.1.3.tar.gz (8.9 kB) Copy SHA256 hash SHA256 Source None Jun 1, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page