WIP - Generate a pdf of the user guide

[Bluesoul02]

Generate a pdf of the user guide using pandoc

Overview

#108

Details

pandoc and xelatex need to be installed to generate the documentation

the pdf is not looking good for now

---

I hereby agree to the terms of the jqwik Contributor Agreement.

[jlink]

I installed pandoc through homebrew and tried to generated the documentation. It failed.

So I cded to documentation/build/docs, which already had user-guide.md and executed

pandoc --pdf-engine=xelatex -s -o user-guide.pdf user-guide.md 

Got the following error:
pandoc: xelatex: createProcess: posix_spawnp: illegal operation (Inappropriate ioctl for device)

Any idea what might be going on?

[Bluesoul02]

It might be an error specific to Mac OS : jgm/pandoc#7570
it looks like it's a problem with xelatex installation, adding xelatex to the PATH might solve the problem, we'll try to see if we can run it on Mac OS on our side.

[jlink]

It might be an error specific to Mac OS : jgm/pandoc#7570 it looks like it's a problem with xelatex installation, adding xelatex to the PATH might solve the problem, we'll try to see if we can run it on Mac OS on our side.

I had to install another package that contains xelatex. On mac that's mactex which is actually very large and took half an hour to install.

Do you think there's a way with a smaller footprint for generating a pdf?

[Bluesoul02]

So I found two alternatives that have a smaller footprint, but I'm still working on getting them to work.
https://github.com/fntsoftware/gradle-plugin-markdown2pdf
https://pypi.org/project/Markdown2PDF/

[vlsi]

Should this specify task inputs and task outputs?
Inputs and outputs would enable Gradle to track up-to-date properly, and the task could even become build-cacheable in the future.