This repo describes a simple way to use pandoc to generate documentation as html or a printable pdf.
The documentation needs to be readable even when there is no connection to the internet, this is why no files are pulled from a CDN.
| folder | description |
|---|---|
| config | Configuration that can be used to control the output. |
| content | This directory contains the example content, this can be fully replaced. |
| template | This directory holds the templates for pdf and html rendering. |
- - add css framework
- - describe installation
- - make scripts for generating pdfs
For windows you'll need to install pandoc, this software can be found at https://pandoc.org/installing.html#windows.
If you want to be able to generate pdfs, please also install the following latex engine: https://miktex.org/download
Run the following command:
sudo apt install pandoc texlive texlive-latex-extra