Metadata-Version: 2.1
Name: py-gfm
Version: 1.0.0
Summary: An implementation of Github-Flavored Markdown written as an extension to the Python Markdown library.
Home-page: https://github.com/zopieux/py-gfm
Author: Dart Team, Alexandre Macabies
Author-email: web+oss@zopieux.com
License: UNKNOWN
Description: GitHub-Flavored Markdown for Python
        ===================================
        
        |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`_.
        
        .. _GitHub-Flavored Markdown: http://github.github.com/github-flavored-markdown/
        .. _Markdown: https://pythonhosted.org/Markdown/
        .. _Read the Docs: https://py-gfm.readthedocs.org/
        .. _LICENSE: /LICENSE
        .. _`the docs`: https://py-gfm.readthedocs.org/#unsupported-features
        .. _`own implementation`: https://github.com/github/cmark-gfm
        
        .. |Build status| image:: https://github.com/Zopieux/py-gfm/workflows/Test%20and%20package/badge.svg
           :target: https://github.com/Zopieux/py-gfm/actions?query=workflow%3A%22Test+and+package%22
           :alt: Build status
        .. |Coverage status| image:: https://coveralls.io/repos/github/Zopieux/py-gfm/badge.svg?branch=master
           :target: https://coveralls.io/github/Zopieux/py-gfm?branch=master
           :alt: Coverage status
        .. |Documentation status| image:: https://readthedocs.org/projects/py-gfm/badge/?version=latest
           :target: https://py-gfm.readthedocs.org/en/latest/?badge=latest
           :alt: Documentation Status
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Topic :: Text Processing :: Markup
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.5
Description-Content-Type: text/x-rst
