pelican-pandoc-reader/README.md

pandoc_reader
=============

A pandoc [markdown] reader plugin for [pelican]


Requirements
------------

  - [pandoc] in $PATH


Installation
------------

Instructions for installation of pelican plugins can be obtained from the [pelican plugin 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's markdown extensions can be enabled or disabled via the
PANDOC_EXTENSIONS parameter.

    PANDOC_EXTENSIONS = [
      '+hard_line_breaks',
      '-citations'
    ]

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


[markdown]: http://daringfireball.net/projects/markdown/
[pandoc]: http://johnmacfarlane.net/pandoc/
[pelican]: http://getpelican.com
Initial commit 2014-03-26 10:18:33 +00:00			`pandoc_reader`
			`=============`

Update README.md 2014-10-16 08:22:06 +00:00			`A pandoc [markdown] reader plugin for [pelican]`
expanded readme 2014-03-26 10:35:07 +00:00

			`Requirements`
			`------------`

			`- [pandoc] in $PATH`


			`Installation`
			`------------`

Update README.md 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).`
expanded readme 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',`
			`]`

Fixes and enhancements including: * Add PANDOC_EXTENSIONS configuration variable, allowing one to enable or disable Pandoc's markdown extensions individually. * Remove dependency on pypandoc. * Don't change the working directory. * More efficient metadata extraction. 2014-11-26 18:42:37 +00:00			`Pandoc's markdown extensions can be enabled or disabled via the`
			`PANDOC_EXTENSIONS parameter.`

			`PANDOC_EXTENSIONS = [`
			`'+hard_line_breaks',`
			`'-citations'`
			`]`
expanded readme 2014-03-26 10:35:07 +00:00
added instructions for contributions 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`


Update README.md 2014-10-16 08:22:06 +00:00			`[markdown]: http://daringfireball.net/projects/markdown/`
expanded readme 2014-03-26 10:35:07 +00:00			`[pandoc]: http://johnmacfarlane.net/pandoc/`
Update README.md 2014-10-16 08:22:06 +00:00			`[pelican]: http://getpelican.com`