Markdown ist eine einfache Sprache, die darauf ausgelegt ist, das Schreiben von Inhalten zu erleichtern. Es wird überall verwendet, von GitHub bis zu Notiz-Apps. Egal, ob Sie ein Autor, Entwickler oder einfach nur jemand sind, der das Schreiben im Web vereinfachen möchte, dieser Leitfaden ist für Sie!
Markdown ist eine leichtgewichtige Auszeichnungssprache, die 2004 von John Gruber entwickelt wurde, um formatierten Text in einfachen Texteditoren lesbar zu halten. Es ist besonders beliebt für Blogs, Instant Messaging, Foren, Collaboration-Tools, Dokumentation und README-Dateien. Im Laufe der Zeit führten Variationen in seiner Interpretation zur Schaffung von CommonMark im Jahr 2014, einer klareren Spezifikation mit einem Testpaket, um eine konsistente Implementierung zu gewährleisten.
Hier eine schnelle Übersicht über die gängigsten Elemente, die Sie benötigen:
Überschriften werden mit dem #-Symbol gefolgt von einem Leerzeichen erstellt:
# Das ist eine H1
## Das ist eine H2
### Das ist eine H3Für Kursiv verwenden Sie *Sternchen* oder _Unterstriche_.
Für Fett verwenden Sie **doppelte Sternchen** oder __doppelte Unterstriche__.
Verwenden Sie Sternchen, Pluszeichen oder Minuszeichen gefolgt von einem Leerzeichen:
* Punkt 1
* Punkt 2
* Unter-Punkt 2.1
* Unter-Punkt 2.2Verwenden Sie einfach Zahlen gefolgt von Punkten:
1. Erster Punkt
2. Zweiter Punkt
3. Dritter PunktEin Inline-Link hat folgende Syntax:
[Angezeigter Text](URL "Optional Title")Bilder ähneln Links, haben jedoch ein vorangestelltes Ausrufezeichen:
Verwenden Sie das >-Zeichen vor Ihrem Text:
> Dies ist ein Blockzitat.Für Code innerhalb des Textes, umschließen Sie Ihren Code mit Backticks:
`Code hier`Für mehrzeilige Codeblöcke verwenden Sie dreifache Backticks:
\```
Zeile 1 des Codes
Zeile 2 des Codes
Zeile 3 des Codes
\```Erstellen Sie eine horizontale Linie mit drei Bindestrichen, Sternchen oder Unterstrichen:
---| Überschrift1 | Überschrift2 |
|-------------|-------------|
| Zelle1 | Zelle2 |
| Zelle3 | Zelle4 || Überschrift1 | Überschrift2 |
|---|---|
| Zelle1 | Zelle2 |
| Zelle3 | Zelle4 |
- [x] Erledigte Aufgabe
- [ ] Nicht erledigte Aufgabe[Linktext](#ankername)# Diese Überschrift ist ein Anker
[Link zum obigen Anker](#diese-überschrift-ist-ein-anker)Markdown hat keine eingebaute Syntax für Zitate, aber viele Tools wie Pandoc unterstützen Erweiterungen dafür.
Laut Smith [-@Smith2023] ist Markdown erstaunlich einfach.
Dies wurde auch von Doe [@Doe2022] in seiner neuesten Veröffentlichung beobachtet.[@Smith2023, S. 23-25][@Doe2022, Kap. 2]Hinweis: Beachten Sie die Verwendung von - vor @Smith2023. So wird der Name des Autors nicht wiederholt, wenn Sie das Zitat in Klammern setzen möchten. Ohne - würde es als narrative Zitierung betrachtet.
Zum Erstellen und Verwalten Ihrer Bibliografie empfehlen wir CiteDrive. CiteDrive ist ein Cloud-basierter, kollaborativer Referenzmanager, der nativ für BibTeX entwickelt wurde, speziell für Overleaf, LaTeX und R Markdown-Benutzer. Es erleichtert das Erstellen und Exportieren von Zitaten im .bib-Format.
Hier ein Beispiel für einen BibTeX-Eintrag, den Sie in Ihrer .bib-Datei haben könnten:
@article{Smith2023,
title = {Studientitel},
author = {Smith, John},
year = 2023,
journal = {Journalname},
volume = 5,
pages = {10--20}
}Pandoc kann Ihre Markdown-Datei mit Zitaten in ein korrekt formatiertes Dokument mit CSL-Stil umwandeln. Hier ist der grundlegende Befehl:
pandoc ihreDatei.md --citeproc --bibliography=ihreBibDatei.bib --csl=ihreCSLStil.csl -o output.docxWobei:
ihreDatei.md ist Ihre Markdown-Datei.--citeproc aktiviert den Zitierprozessor.ihreBibDatei.bib ist Ihre Bibliografiedatei.ihreCSLStil.csl ist Ihr gewählter Zitierstil (z. B. APA, MLA usw.). Es gibt viele CSL-Stile online verfügbar.output.docx ist die gewünschte Ausgabedatei (in diesem Fall ein Word-Dokument).Denken Sie daran, dass Sie sowohl Pandoc als auch die entsprechenden CSL-Dateien benötigen, damit dies funktioniert. Das endgültige Ergebnis hängt von dem von Ihnen gewählten CSL-Stil ab.