| __init__.py | ||
| .gitignore | ||
| pandoc_reader.py | ||
| README.md | ||
pandoc_reader
A pandoc markdown reader plugin for pelican
Requirements
- pandoc in $PATH
- PyYAML installed if you want to parse YAML metadata
Installation
Instructions for installation of pelican plugins can be obtained from the pelican plugin manual.
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'
]
YAML Metadata
No configuration is required to use YAML metadata. Simply include it at the top
of your post, started by --- and terminated by --- or .... If PyYAML is
not installed, the data will be parsed by the normal metadata parser instead.
For example:
---
title: Using YAML with Pandoc!
author: Your Name
date: 2015-05-15 14:07
description: >
You can include long, multiline descriptions which
can wrap across multiple lines (and will be joined
by YAML).
complex:
- or complex data structures
- like lists
...
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request