jqwik icon indicating copy to clipboard operation
jqwik copied to clipboard

WIP - Generate a pdf of the user guide

Open Bluesoul02 opened this issue 4 years ago • 4 comments

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.

Bluesoul02 avatar Dec 06 '21 17:12 Bluesoul02

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?

jlink avatar Dec 07 '21 08:12 jlink

It might be an error specific to Mac OS : https://github.com/jgm/pandoc/issues/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.

Bluesoul02 avatar Dec 07 '21 21:12 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.

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?

jlink avatar Dec 08 '21 11:12 jlink

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/

Bluesoul02 avatar Dec 27 '21 23:12 Bluesoul02