https://github.com/roaldnefs/writeup-template
https://github.com/roaldnefs/writeup-template
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/roaldnefs/writeup-template
- Owner: roaldnefs
- Created: 2020-03-06T06:47:39.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-06-11T06:15:02.000Z (almost 5 years ago)
- Last Synced: 2025-04-05T09:34:25.094Z (about 1 month ago)
- Language: Makefile
- Size: 9.77 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Writeup Template
This repository contains a template for my writeups.
## Installation
Install the required packages:
### Debian
```console
$ sudo apt install texlive texlive-xetex texlive-fonts-recommended \
texlive-fonts-extra pandoc
```
### Fedora
```console
$ sudo dnf install texlive texlive-latex texlive-xetex texlive-collection-fontsrecommended \
texlive-collection-fontsextra pandoc texlive-footnotebackref texlive-pagecolor texlive-mdframed \
texlive-titling
```
### Mac OS
```console
$ brew install mactex
```
Install the required **pandoc LaTeX template** called [Eisvogel](https://github.com/Wandmalfarbe/pandoc-latex-template):
1. Download the latest version of Eisvogel template from [the release page](https://github.com/Wandmalfarbe/pandoc-latex-template/releases).
2. Extract the downloaded ZIP archive and open the folder.
3. Move the template `eisvogel.tex` to your pandoc templates folder and rename the file to `eisvogel.latex`. The location of the templates folder depends on your pandoc installation: `$HOME/.local/share/pandoc/templates/` or `$HOME/.pandoc/templates/`.
## Usage
To generate the PDF run the following command or use the supplied `Makefile`:
```console
$ pandoc --from markdown --pdf-engine=xelatex --template eisvogel --listings -o writeup.pdf writeup.md
```