Skip to main content

Hoedown Markdown formatter for PieCrust via Misaka

Project description

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.

Project details


Release history Release notifications

This version
History Node

0.1.0

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
PieCrust_Hoedown-0.1.0-py3-none-any.whl (5.4 kB) Copy SHA256 hash SHA256 Wheel py3 Feb 14, 2018
PieCrust-Hoedown-0.1.0.tar.gz (3.9 kB) Copy SHA256 hash SHA256 Source None Feb 14, 2018

Supported by

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