Skip to content
/ isits-markdown-thesis Public template

A pandoc LaTeX template for creating a thesis in markdown at Ruhr-Universität Bochum / isits (International School of IT Security AG)

Notifications You must be signed in to change notification settings

M3NIX/isits-markdown-thesis

Folders and files

NameName
Last commit message
Last commit date

Latest commit

2dcb824 · Aug 16, 2024

History

14 Commits
Feb 12, 2023
Jan 13, 2023
Aug 15, 2024
Jan 13, 2023
Aug 16, 2024
Jan 13, 2023
May 17, 2024
Jan 13, 2023
Jan 13, 2023
May 17, 2024
Aug 16, 2024
Aug 16, 2024

Repository files navigation

isits-markdown-thesis

This project is setup to write a thesis in simple markdown and convert it to a good looking document with the help of pandoc and LaTeX.

Example content can be found in the markdown folder and the resulting pdf here.

Setup

Docker (recommended):

# https://docs.docker.com/engine/install/
# your linux user should be able to run docker commands without sudo 
# https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user
make docker-build

Ubuntu/Debian:

# download latest pandoc from https://github.com/jgm/pandoc/releases
wget https://github.com/jgm/pandoc/releases/download/2.19.2/pandoc-2.19.2-1-amd64.deb
sudo dpkg -i ./pandoc-2.19.2-1-amd64.deb
sudo apt install -y make texlive-latex-recommended texlive-science texlive-latex-extra texlive-lang-german latexmk biber python3-pip python-is-python3
python -m pip install --user pandocfilters pandoc-include pandoc-acro # make sure ~/.local/bin/ is in your path

Arch Linux:

sudo pacman -S make pandoc texlive-core texlive-science texlive-latexextra biber python-pip
python -m pip install --user pandocfilters pandoc-include pandoc-acro # make sure ~/.local/bin/ is in your path

Usage

Generate pdf:

make docker-pdf # or `make pdf` without docker

Generate latex file only:

make docker-tex # or `make tex` without docker

Delete files generated during build process:

make clean

Configuration

File Description
pandoc/config.yml config file for pandoc (language, fontsize, enable/disable lists, ...)
latex/template.tex latex template used by pandoc
data/metadata.yml metadata information for the titelpage (title, author, ...)
data/references.bib bibliography in BibTeX format
data/acronyms.yml Acronym Definitions (more details)

Credits