Skip to content

Latest commit

 

History

History
30 lines (18 loc) · 918 Bytes

README.md

File metadata and controls

30 lines (18 loc) · 918 Bytes

User Manual

This manual is built with https://github.com/LibreSolar/md-manual-template

This is a template that uses Pandoc to auto-generate PDF and HTML manuals based on markdown content.

Please install the most recent Pandoc package to get best results on your local computer.

PDF generation

PDF files are generated using LaTeX, so a working LaTeX engine needs to be installed on your system already (e.g. texlive incl. extra fonts). The manual uses the Eisvogel template.

cd manual
make pdf

HTML generation

The HTML template is based on the great mdBook theme, which was simplified and adjusted a bit to suit the needs of a manual.

cd manual
make html

Docker image

Included is a Dockerfile with all the dependencies for pandoc and latex installed.