|
0
|
1
|
|
|
2 This plugin for `PieCrust`_ lets you use `Hoedown Markdown`_ via `Misaka`_ for
|
|
|
3 faster Markdown processing. It's much faster than the default pure Python (but
|
|
|
4 more universal) Markdown formatter that comes by default with PieCrust.
|
|
|
5
|
|
|
6 To install the plugin::
|
|
|
7
|
|
|
8 pip install piecrust-hoedown
|
|
|
9
|
|
|
10 Then enable it in your website configuration::
|
|
|
11
|
|
|
12 site:
|
|
|
13 plugins: [hoedown]
|
|
|
14
|
|
|
15 You can specifically use the Hoedown formatter on a per-page basis by adding
|
|
|
16 ``format: hoedown`` in the page's configuration header, but you might want to
|
|
|
17 just make it the default formatter for the whole website::
|
|
|
18
|
|
|
19 site:
|
|
|
20 default_format: hoedown
|
|
|
21 auto_formats:
|
|
|
22 md: hoedown
|
|
|
23
|
|
|
24 The Hoedown formatter should be mostly compatible with the default Markdown
|
|
|
25 formatter, in the sense that making it the default formatter as specified above
|
|
|
26 should just work, and would make the website bake faster. However, if you were
|
|
|
27 using Markdown Extensions, there may or may not be any equivalent in Hoedown.
|
|
|
28 In this case, your best bet is to replace ``markdown`` with ``hoedown`` when
|
|
|
29 declaring the extensions, and see if there's an error about an extension not
|
|
|
30 existing. For instance::
|
|
|
31
|
|
|
32 site:
|
|
|
33 default_format: hoedown
|
|
|
34 hoedown:
|
|
|
35 extensions: [fenced_code, footnotes, smarty]
|
|
|
36
|
|
|
37 The list of `extensions`_ is available on the Misaka documentation. Any
|
|
|
38 extension with a dash can also be written with an underscore.
|
|
|
39
|
|
|
40 .. _piecrust: http://bolt80.com/piecrust/
|
|
|
41 .. _hoedown markdown: https://github.com/hoedown/hoedown
|
|
|
42 .. _misaka: http://misaka.61924.nl/
|
|
|
43 .. _extensions: http://misaka.61924.nl/#extensions
|
