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.

Documentation

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

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-0.1.3.tar.gz (8.9 kB view hashes)

Uploaded Source

Built Distribution

py_gfm-0.1.3-py2.py3-none-any.whl (13.9 kB view hashes)

Uploaded Python 2 Python 3

Supported by

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