timconsidine/Cloudron-Pandoc-PDF-Builder
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

first commit

Browse Source
This commit is contained in:
Tim Considine 2022-01-29 12:05:24 +02:00
commit 83b1acef9e
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md Normal file
View File

@ -0,0 +1,23 @@
This app is a custom (not officially developed or maintained) app packaged for Cloudron.
It packages an instance of the excellent document conversion utility Pandoc (https://pandoc.org).
Pandoc only runs from the command line. By packaging it into a web app, a consistent publishing environment can be maintained in a single location (avoiding multiple local installs which might change over time) and be accessible from any device, even without Pandoc and its utilities installed.
It is based on Cloudron's tutorial-supervisor app and the padoc docker app from Viktor Petersson <vpetersson@wireload.net> (https://github.com/vpetersson/docker-pandoc).
Upload a source document in Markdown (.md) format plus any images to be included.
This app will process them using Pandoc (https://pandoc.com) with a tweaked <a href="https://github.com/Wandmalfarbe/pandoc-latex-template">eisvogel template</a> and <a href="https://www.ctan.org/tex-archive/graphics/awesomebox">awesomebox.sty</a> to create a beautiful PDF, without the hassle of manual formatting in Word etc.
Once the source Markdown and related images files are uploaded, click the button to process them.
The app will create a PDF, which must be downloaded to the local computer, as it cannot be retrieved later.
The source Markdown file will be moved to /app/data/done (in future version, it will be deleted).
Image files will not be moved, in case they are required for subsequent PDF creations, e.g.on updating and re-uploading the source Markdown file.
NB : currently source image files might be overwritten by other users of the app uploading a file of the same name but different content. Your document will then be. reated with the wrong image. If so, re-upload them and retry. This issue will be addressed in a future version.
Authenitcation may be added later (currently not required under initial use case).