Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add official lua-filters to pandoc images #127

Closed
florian6973 opened this issue Nov 20, 2020 · 6 comments · Fixed by #231
Closed

Add official lua-filters to pandoc images #127

florian6973 opened this issue Nov 20, 2020 · 6 comments · Fixed by #231
Labels
enhancement New feature or request image:extra Image with plenty of LaTeX extras

Comments

@florian6973
Copy link

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!

@cagix
Copy link

cagix commented Nov 20, 2020

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?

@svenevs
Copy link
Member

svenevs commented Nov 20, 2020

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 ❤️).

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.

@cannyboy
Copy link

cannyboy commented Dec 7, 2020

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.

@tarleb
Copy link
Member

tarleb commented Dec 7, 2020

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
Copy link
Member

tarleb commented Jan 5, 2022

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

@caenrique
Copy link

any updates on including filters? having a mermaid filter would be awesome for using in in github actions to render diagrams

daamien added a commit that referenced this issue May 6, 2024
@daamien daamien added enhancement New feature or request image:extra Image with plenty of LaTeX extras labels May 6, 2024
@daamien daamien closed this as completed in a8b3af5 May 6, 2024
@daamien daamien reopened this May 7, 2024
daamien added a commit that referenced this issue May 7, 2024
daamien added a commit that referenced this issue May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request image:extra Image with plenty of LaTeX extras
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants