pandoc-reader/README.md

47 lines
930 B
Markdown
Raw Normal View History

2014-03-26 10:18:33 +00:00
pandoc_reader
=============
A pandoc markdown reader plugin for pelican
2014-03-26 10:35:07 +00:00
Requirements
------------
- [pypandoc]
- [pandoc] in $PATH
Installation
------------
2014-04-02 08:49:14 +00:00
Instructions for installation of pelican plugins can be obtained from the [pelican plugin manual](https://github.com/getpelican/pelican-plugins/blob/master/Readme.rst).
2014-03-26 10:35:07 +00:00
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',
]
2014-04-26 11:08:59 +00:00
Contributing
------------
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
2014-03-26 10:35:07 +00:00
[pandoc]: http://johnmacfarlane.net/pandoc/
[pypandoc]: https://github.com/bebraw/pypandoc