aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 842651faa0a7366bbf49e2b9cbf44ee8b2cab522 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
# Reports templating system

This is the templating system I use to generate my reports.

It's a (heavy) work in progress as I am still learning latex. 

it consists of a bash script that I can use to create a new markdown file for my reports and then I can use the same script to run pandoc on the markdown and output a pdf.

## Requirements

latex and pandoc installed. Texlive is part of slackware and the extras and pandoc packages can be obtained from [slackbuilds.org](https://slackbuilds.org).

On my slackware64-current I have:

- texlive-2024.240409-x86_64-4
- texlive-extra-2024.240409-x86_64-1_SBo
- pandoc-bin-3.8-x86_64-1_SBo

## Install

this is the directory structure I use:

- ~/bin
  - **makereport** (the bash script)
- ~/.local/share/pandoc/templates
  - **reports.latex** (the latex template)
  - **reports.theme** (the color theme for the code highlighting)
- ~/Documents/reports/template/
  - **template.md** (the empty markdown template)
- ~/Pictures
  - signature.png (optional signature image)

## How to

```bash
makereport -t > "new report.md"
```

This will generate the markdown with the template.

```bash
makereport -o "new report.pdf" "new report.md"
```

This command will generate the pdf document.

## Inspiration

This script is based on the reports script by Valerio Casalino aka 5amu on github. *Grazie mille Valerio* 🫶🏻

## Mantainer

 * [danix](https://danix.xyz) - it's just me, really..

## LICENSE

makerepo © 2025 by danix is licensed under CC BY-NC 4.0. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc/4.0/