Skip to content

JeromeTDev/md2thesis

Repository files navigation

md2thesis

🇩🇪 Deutsch

Lizenz: CC BY-SA 4.0
Workflow: Markdown → Pandoc → PDF via LaTeX

md2thesis ist ein modernes, modulares Template, um akademische Arbeiten oder Bachelorarbeiten aus Markdown-Dateien zu erstellen. Es unterstützt:

  • Automatische PDF-Erstellung via Pandoc und LaTeX
  • Literaturverwaltung über Zotero und BibTeX
  • Inhaltsverzeichnis, Abbildungsverzeichnis, Tabellenverzeichnis
  • Modulare Kapitelstruktur für einfaches Bearbeiten

🚀 Schnellstart

  1. Repository klonen:
git clone https://github.com/USERNAME/md2thesis.git
cd md2thesis
chmod +x scripts/compile.sh
./scripts/compile.sh   # Generiert Bachelorarbeit.pdf
  1. Die generierte PDF erscheint als Bachelorarbeit.pdf im Projektverzeichnis.

📂 Projektstruktur

md2thesis/
├── chapters/            # Markdown-Kapitel
├── assets/              # Bilder, Diagramme, Code
├── scripts/             # Compile-Skripte
├── metadata.yaml        # PDF/LaTeX-Einstellungen
├── Literatur.bib        # BibTeX-Literatur (Zotero)
├── ieee.csl             # Citation Style
└── README.md

🔧 Konfiguration

Alle globalen Einstellungen befinden sich in metadata.yaml:

title: "Titel der Arbeit"
subtitle: "Untertitel"
author: |
  Dein Name  
  Studiengang, Matrikelnummer
date: "\\today"
lang: de
... (weitere Einstellungen siehe Vorlage)

🌟 Features

  • Plattformunabhängig: Windows, macOS, Linux
  • Versionskontrolle mit Git
  • Automatisches Inhalts-, Abbildungs- und Tabellenverzeichnis
  • Dynamische Referenzen und Zitate

📖 Zitationen mit Zotero

  • BibTeX-Datei (Literatur.bib) aus Zotero exportieren
  • CSL-Format (ieee.csl, apa.csl) in metadata.yaml eintragen
  • Pandoc wandelt Zitate automatisch in PDF um

🇬🇧 English

License: CC BY-SA 4.0
Workflow: Markdown → Pandoc → PDF via LaTeX

md2thesis is a modern, modular template to create academic papers or Bachelor theses from Markdown files. It supports:

  • Automatic PDF generation via Pandoc and LaTeX
  • Bibliography management via Zotero and BibTeX
  • Table of contents, figure and table lists
  • Modular chapter structure for easy editing

🚀 Quick Start

  1. Clone the repository:
git clone https://github.com/USERNAME/md2thesis.git
cd md2thesis
chmod +x scripts/compile.sh
./scripts/compile.sh   # Generates Bachelorarbeit.pdf
  1. The generated PDF will appear as Bachelorarbeit.pdf in the project directory.

📂 Project Structure

md2thesis/
├── chapters/            # Markdown chapters
├── assets/              # Images, diagrams, code snippets
├── scripts/             # Compile scripts
├── metadata.yaml        # PDF/LaTeX settings
├── Literatur.bib        # BibTeX bibliography (Zotero)
├── ieee.csl             # Citation style
└── README.md

🔧 Configuration

All global settings are in metadata.yaml:

title: "Thesis Title"
subtitle: "Subtitle"
author: |
  Your Name
  Degree Program, Student ID
date: "\\today"
lang: en
... (more settings see template)

🌟 Features

  • Cross-platform: Windows, macOS, Linux
  • Version-controlled with Git
  • Automatic TOC, list of figures, and list of tables
  • Dynamic references and citations

📖 Citations with Zotero

  • Export BibTeX file (Literatur.bib) from Zotero
  • Set CSL format (ieee.csl, apa.csl) in metadata.yaml
  • Pandoc automatically renders citations in PDF

About

Convert Markdown into a Bachelor thesis or academic paper PDF (Pandoc + LaTeX)

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published