expanded readme

This commit is contained in:
liob 2014-03-26 11:35:07 +01:00
parent 7a3632f391
commit ae7d07898e

View File

@ -2,3 +2,36 @@ pandoc_reader
============= =============
A pandoc markdown reader plugin for pelican A pandoc markdown reader plugin for pelican
Requirements
------------
- [pypandoc]
- [pandoc] in $PATH
Installation
------------
Instructions for installation of pelican plugins can be obtained here: [manual](https://github.com/getpelican/pelican-plugins/blob/master/Readme.rst)
Configuration
-------------
Additional command line parameters can be passed to pandoc via the PANDOC_ARGS parameter.
PANDOC_ARGS = [
'--mathjax',
'--smart',
'--toc',
'--toc-depth=2',
'--number-sections',
]
[pandoc]: http://johnmacfarlane.net/pandoc/
[pypandoc]: https://github.com/bebraw/pypandoc