Metadata-Version: 2.0
Name: PieCrust-Hoedown
Version: 0.1.0
Summary: Hoedown Markdown formatter for PieCrust via Misaka
Home-page: http://bolt80.com/piecrust
Author: Ludovic Chabant
Author-email: ludovic@chabant.com
License: Apache2
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Dist: PieCrust (>=2.0.0)
Requires-Dist: misaka (>=2.1.0)


This plugin for `PieCrust`_ lets you use `Hoedown Markdown`_ via `Misaka`_ for
faster Markdown processing. It's much faster than the default pure Python (but
more universal) Markdown formatter that comes by default with PieCrust.

To install the plugin::

    pip install piecrust-hoedown

Then enable it in your website configuration::

    site:
      plugins: [hoedown]

You can specifically use the Hoedown formatter on a per-page basis by adding
``format: hoedown`` in the page's configuration header, but you might want to
just make it the default formatter for the whole website::

    site:
      default_format: hoedown
      auto_formats:
        md: hoedown

The Hoedown formatter should be mostly compatible with the default Markdown
formatter, in the sense that making it the default formatter as specified above
should just work, and would make the website bake faster. However, if you were
using Markdown Extensions, there may or may not be any equivalent in Hoedown.
In this case, your best bet is to replace ``markdown`` with ``hoedown`` when
declaring the extensions, and see if there's an error about an extension not
existing. For instance::

    site:
      default_format: hoedown
    hoedown:
      extensions: [fenced_code, footnotes, smarty]

The list of `extensions`_ is available on the Misaka documentation. Any
extension with a dash can also be written with an underscore.

.. _piecrust: http://bolt80.com/piecrust/
.. _hoedown markdown: https://github.com/hoedown/hoedown
.. _misaka: http://misaka.61924.nl/
.. _extensions: http://misaka.61924.nl/#extensions


