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

update README

Browse Source
This commit is contained in:
Tim Considine 2022-01-29 12:59:52 +02:00
parent 55a214ec8e
commit 295c5bac80
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -9,6 +9,9 @@ It is based on Cloudron's tutorial-supervisor app and the padoc docker app from
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.
A file awesomebox.pdf is included to show what is possible for styling effects.
A sample document (sample.md) with sample cover (sample-background.pdf) and a sample logo / image (sample-logo.png) are provided, along with what the app will produce (sample.pdf).
Once the source Markdown and related images files are uploaded, click the button to process them.
@ -20,4 +23,4 @@ Image files will not be moved, in case they are required for subsequent PDF crea
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).
Authentication may be added later (currently not required under initial use case).