expanded readme
This commit is contained in:
parent
7a3632f391
commit
ae7d07898e
33
README.md
33
README.md
@ -2,3 +2,36 @@ pandoc_reader
|
||||
=============
|
||||
|
||||
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
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user