Tipps - Markdown mit Bibliografie

Blog Digitalgesellschaft Verwaltungsbetrieb Textarchiv Textarchiv Walter Kirk (✝) Impressum

Markdown mit Bibliografie

Vorbemerkung

Markdown eignet sich wegen der Einfachheit zur meist komplikationslosen Texterstellung. LaTeX- und HTML-Code kann in .md eingegeben und über Pandoc zur Erstellung von Dokumenten verwendet werden. Mit Pandoc lassen sich aus .md qualitativ hochwertige Ausgabeformate wie beispielsweise .epub, .html und .pdf erstellen.

Somit ist es möglich, die eigene Bibliografie (.bib) in ein Markdown-Dokument zu integrieren.

Voraussetzungen

Bibliografie

Eine eigene .bib sollte vorzugsweise bereits vorhanden sein. Zur Erstellung kann das Programm JabRef genutzt werden.

Im Beispiel liegt eine literatur.bib mit folgenden Einträgen vor:


x
@misc{shd101wyy_2020, 
title={Markdown-preview-enhanced/pandoc-bibliographies-and-citations.md at master · SHD101WYY/markdown-preview-enhanced}, 
url={https://github.com/shd101wyy/markdown-preview-enhanced/blob/master/docs/pandoc-bibliographies-and-citations.md}, 
journal={GitHub}, 
author={shd101wyy},
year={2020},
month={Mar}
} 

@online{ekalininName,
    author = {ekalinin},
    title = {Name already in use},
    year = ,
    url = {https://github.com/ekalinin/github-markdown-toc},
    urldate = {2023-06-11}
}

Citation Style Language

Für das Literaturverzeichnis ist es sinnvoll, den Zitierstil anzugeben. Dazu wird eine entsprechende .csl aus dem CSL-Repository herunter geladen und in ein Verzeichnis gespeichert.

Programme

MD-Editor

Eine .md kann mit jedem Texteditor erstellt werden. Empfohlen wird die Nutzung eines MD-Editors. Im Beispiel wird Zettlr zur Erstellung genutzt (Linux, macOs, Windows).

Pandoc

Damit die eigene Bibliothek im Dokument ausgegeben wird, ist das Paket Pandoc zu installieren. Diese Software steht für alle gängigen Betriebssysteme als Open-Source zur Verfügung (Linux, macOS, Windowss).

TeX

Das Textsatzsystem muss zumindest als Basis installiert sein.

Installation

Unter debian-basierten Systemen wird Pandoc und TeX installiert mit:


xxxxxxxxxx
test@geraet: $ sudo apt install pandoc texlive-basis

Dokument

Im Beispiel wird eine test.md erstellt.

YAML

Im YAML-Frontmatter werden folgende Daten eingetragen:


xxxxxxxxxx
---
lang: de-DE
documentclass: article
colorlinks: true
toc: true
title: "Titel der Arbeit"
subtitle: ""
author: Nutzername
bibliography: literatur.bib
csl: "/home/nutzer/csl/din-1505-2.csl"
header-includes:  
     \usepackage{color}
     \usepackage{caption}
     \captionsetup[figure]{
        name=,
        labelsep=none,
        labelformat=empty}
---

Die Angaben bis csl sind soweit selbst erklärend. Unter header-includes werden LaTeX-Einstellungen zur Erstellung des Ausgabeformates vorgenommen.

Text

Im laufenden Text werden die Zitate in der Form eingegeben:


xxxxxxxxxx
@key

Der key ist die Angabe der Zeichenfolge nach der Dokumentenart aus der .bib.

Quelle: @shd101wyy_2020

Ein Text mit Zitat sieht dann so aus:


xxxxxxxxxx
## Überschrift1

Blah Blah Blah (@shd101wyy_2020)

## Überschrift2

Blah Blah Blah (@ekalininName)

## Literatur

Ausgabe

Zur Ausgabe der gewünschten Formate ist im Arbeitsverzeichnis ein Terminal zu öffnen und auszuführen:

PDF


xxxxxxxxxx
test@geraet:~/$ pandoc --toc -s --metadata link-citations=true --citeproc -s test.md -o test.pdf

EPUB


xxxxxxxxxx
test@geraet:~/$ pandoc --toc -s --metadata link-citations=true --citeproc -s test.md -o test.epub

HTML


xxxxxxxxxx
test@geraet:~/$ pandoc --toc -s --metadata link-citations=true --citeproc -s test.md -o test.html

CSS

Eine .css muss im Arbeitsverzeichnis abgespeichert sein. Sie muss im Kommando zusätzlich angegeben werden:


xxxxxxxxxx
test@geraet:~/$ pandoc --toc -s --metadata link-citations=true --citeproc --css=name.css -s test.md -o test.html

Besonderheit

CSS ergänzen

Wer eine eigene .css nutzen will, sollte mit einem Texteditor folgende Zeilen im Kopf der Datei einfügen. Damit wird die Ausgabe der TOC über Pandoc auf die eigenen Verhältnisse angepasst:


xxxxxxxxxx
ol.toc { padding: 0; margin-left: 1em; }
ol.toc li { list-style-type: none; margin: 0; padding: 0; }

TOC erstellen

Im Beispiel enthält die .epub ein Inhaltsverzeichnis ohne Nummerierung.

Sofern aufgrund veränderter Einstellungen keine TOC vorhanden ist, lässt sich das wie folgt beheben:

Pandoc


xxxxxxxxxx
test@geraet: $ pandoc -f gfm --toc -s test.md -o test-toc.md

Quelle: https://superuser.com/questions/909755/generate-table-of-contents-with-links-for-github-markdown-with-pandoc

GH-MD-TOC

Schritt 1: gh-md-toc herunter laden


x
test@geraet: $ wget https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc
test@geraet: $ chmod a+x gh-md-toc

Schritt 2: Programm ausführen


xxxxxxxxxx
test@geraet: $ ./gh-md-toc test.md >test-toc.md

Schritt 3: TOC übernehmen

Im Beispiel wird das Inhaltsverzeichnis in die test-toc.md gespeichert. Nun lässt sich das Inhaltsverzeichnis durch Copy and Paste in die test.md speichern.

Quelle: https://github.com/ekalinin/github-markdown-toc

TOC Online Generator

Eine Alternative für die Erstellung am PC ist der Online Markdown Table of Contents Generator, mit dem weitere Funktionen einstellbar sind:

https://luciopaiva.com/markdown-toc/

Beispieldsateien

Die test.md, literatur.bib und die Ausgabeformate .epub, .html, .pdf können als Archiv hier herunter geladen werden.

Schlussbemerkung

Texte mit Markdown erstellt und mit Zitaten, die auch in einem Literaturverzeichnis ausführlich enthalten sind, werten die Arbeit mit dieser Form der Texterstellung noch einmal auf.

Eine .md ist einfach erstellt, zumal bei Nutzung eines Editors. Die Umwandlung in das entsprechende Ausgabeformat ist schnell getan und verläuft problemlos.

Top

Stand: 2023-06-11, aktualisiert: 2023-06-15, 19:15 Uhr