Skip to content

Latest commit

 

History

History
68 lines (45 loc) · 1.65 KB

README.md

File metadata and controls

68 lines (45 loc) · 1.65 KB
Raw

org_pandoc_reader

A pandoc org reader plugin for pelican

Requirements

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 ORG_PANDOC_ARGS parameter.

ORG_PANDOC_ARGS = ['--mathjax',
                   '--smart',
                   '--toc',
                   '--toc-depth=2',
                   '--number-sections',
                   '--standalone',
                   '--highlight-style=espresso',]

Usage Notes

Simply use org-mode (.org) files instead of markdown files anywhere in your pelican blog.

Note that in order for code blocks in your or files to be formatted with syntax highlighting, code block headers should be placed on a separate line from the block demarcation. i.e.:

#+headers :results code replace output
#+begin_src sh
# source code
#+end_src

Example

Live example

Contributing

If you have an issue please report it through the GH issues.

  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

Acknowledgements

pandoc_reader