dockerfiles icon indicating copy to clipboard operation
dockerfiles copied to clipboard

Add official lua-filters to pandoc images

Open florian6973 opened this issue 5 years ago • 6 comments

Following this discussion, it would be a great feature, especially for Github Actions, to add lua-filters to the Docker images, because filters like include-files are really useful. Thanks!

florian6973 avatar Nov 20 '20 10:11 florian6973

wouldn't it be easier and also more flexible to just add the desired filters as sub-module to your project and mount the folder inside the docker container?

cagix avatar Nov 20 '20 12:11 cagix

I'm in favor of adding them to the images to make things easier for users, but we'd need to deal with making sure root and non-root users can access them. This one may take time to iron out, this repo is currently in quasi-maintenance mode (thanks @tarleb :heart:).

That said, there are additional complications, specifically some of those filters need external tools we aren't installing. This may increase the size of the images here too much. At the very least, we can vendor the filters themselves and coordinate external tool installation documentation where applicable. Probably best documented in the lua-filters repo and linked to from here.

We should really start tagging releases here and on the lua-filters repo. Ref: #115, possible strategy:

  1. Pandoc release finalized.
  2. Any potential fixes to lua-filters (outstanding PR etc) resolved or put on hold, tag lua-filters repo.
  3. Then we can release here vendoring the newly tagged filters.

svenevs avatar Nov 20 '20 14:11 svenevs

Another vote for including lua filters, together with all the software requirements.

But really, I'd want a kitchen-sink version with everything, including the filter dependencies, old python filters too. And a few filters which are not in official filters, like mermaid. And the latex stuff.

A good use case is a high school student who wants to use text files and pandoc to produce all work, which might include diagrams, music notation, charts, math, flowcharts etc. They could use plain markdown for everything, but the install process for pandoc plus filters plus latex plus dependencies is a bit overwhelming.

cannyboy avatar Dec 07 '20 13:12 cannyboy

I think we'll need official releases of the Lua filters to be able to pack them easily and in a reproducible manner. I've made progress there, but it's not perfect yet.

A kitchen sink image is out of scope for us. You could take build your own by basing it on the lua-filters test image and extend it from there.

tarleb avatar Dec 07 '20 22:12 tarleb

There's a discussion on the lua-filters repo that might be relevant in this context: pandoc/lua-filters#207.

tarleb avatar Jan 05 '22 16:01 tarleb