Logo

Suche in HISTOFOX

Markdown

Markdown ist eine Auszeichnungssprache für Text. Es können grundlegende Formatierungen wie Überschriften, Aufzählungen, Tabellen etc. ausgezeichnet werden. Ziel von Markdown ist es, leicht les- und erstellbar zu sein. SoftwareentwicklungsplattformenModerne Softwareentwicklung findet in aller Regel über speziell dafür entwickelte Plattformen statt, die Methoden zum Projektmanagement und der Verwaltung des Quellcodes bieten. Für Letzteres hat sich das Tool git als De-Facto-Standard etabliert. Softwareentwicklungsplattformen bieten die Möglichkeit, die Entwicklung projektzentriert durchzuführen und neben dem Quellcode beispielsweise ein Wiki zu pflegen und Fehler mittels eines Issue-Trackers nachzuverfolgen. Über diesen können auch Nutzer*innen von Software Fehler melden. Diese Plattformen bieten auch weitere Mechanismen zur Automatisierung, z. B. das automatische Erstellen von lauffähigen Programmen aus dem Quellcode, die dann zum Herunterladen angeboten werden können. Weiterlesen wie GitHub oder GitLab nutzen Markdown beispielsweise für die Formatierung von ReadMeReadMe-Dateien (oft auch Readme geschrieben) im Kontext von Systemen oder Projekten enthalten überblicksartige Informationen zum jeweiligen System, Projekt o. ä., damit die Nutzenden sich schneller zurechtfinden. ReadMe-Dateien dokumentieren die grundlegenden Eigenschaften, z. B. wozu das jeweilige System oder Projekt genutzt werden kann und wo eine weiterführende Dokumentation zu finden ist. Welche konkreten Inhalte in einer ReadMe-Datei enthalten sind, hängt stark vom jeweiligen Einsatzzweck und dem antizipierten Rezipientenkreis ab, also auch, ob diese für die Öffentlichkeit bestimmt sind oder interne Projekte dokumentieren. Weiterlesen-Dateien und Projekt-Wikis.
Ein mit Markdown ausgezeichnetes Beispiel…

…wird in Editoren grafisch dargestellt als:

Überschrift erster Ebene

Markdown ermöglicht die Auszeichnung von Text beispielsweise als kursiv und fett.

  • Durch Sterne werden Listeneinträge ausgezeichnet
  1. Durch Ziffern können Aufzählungen erstellt werden

Zitierweise

Benz, Jacob. 2026. „Markdown“. HISTOFOX. Das Informations-, Lern- und Lehrportal für Datenkompetenzen in den historisch arbeitenden Disziplinen. NFDI4Memory und Freie Universität Berlin. https://histofox.4memory-dataliteracy.de/glossar/markdown/