.. mistune documentation master file, created by
   sphinx-quickstart on Wed Sep 18 13:29:37 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Mistune: Python Markdown Parser
===============================

Release v\ |version|.

A fast yet powerful Python Markdown parser with renderers and plugins,
compatible with sane CommonMark rules.

Using old Mistune? Checkout docs:

- https://mistune.lepture.com/en/v0.8.4/
- https://mistune.lepture.com/en/v2/

Installation
------------

Installing Mistune is quite easy with `pip <http://www.pip-installer.org/>`_.

.. parsed-literal::

    $ pip install mistune==\ |version|

Mistune has no external dependencies.


User Guide
----------

.. toctree::
   :maxdepth: 2

   guide
   cli
   renderers
   plugins
   directives
   advanced
   api
   upgrade
   community
   changes