Skip to content

For Grav CMD, add Pandoc rendering of Markdown using an external pandoc binary.

License

Notifications You must be signed in to change notification settings

evert-mouw/grav-plugin-pandoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Content by Pandoc for Grav

This is a plugin for the Grav CMS.

Now you can render your markdown using Pandoc.

Pandoc is a document converter that supports many markdown extensions.

Requirements

You need:

  • The pandoc executable in your PATH.
  • PHP exec() permission.

Incompatible plugins

These plugins will no longer function correctly:

  • image-captions (but pandoc will convert img alt text to captions)
  • highlight (but pandoc will do that for you)
  • markdown-notices
  • youtube (maybe due to load ordering, if this plugin gets executed before the youtube plugin)
  • ... and probably many more

Recommendations

  • Disable Markdown extra in your config/sytem.yaml (extra: false).
  • Disable markdown processing altogether in your in your config/sytem.yaml (markdown: false).
  • Make sure there is something like <base href="{{ page.url(true, true) }}/"> in your page template so images keep appearing.

Installation

  1. Download the zip version of this repository and unzip it under /your/site/grav/user/plugins
  2. Remove the grav-plugin- prefix from the name; rename this plugin directory/folder name to e.g. pandoc.

The plugin is enabled by default.

Roadmap

  • Make it possible to use the pandoc server mode, resulting in even speedier parsing and also making exec() permission optional.
  • The UID in the vendor/composer was taken from markdown-notices and had the last digit (0) changed (to 2). Maybe do it in a more proper way.

Warning

I only meant to use this on my own blog; I'm a newbee in the Grav world and still struggling with setting up my blog.

Evert Mouw | 2023-03-08

About

For Grav CMD, add Pandoc rendering of Markdown using an external pandoc binary.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages