Markdown

Markdown ist eine einfache Auszeichnungssprache, mit der sich Texte übersichtlich und strukturiert formatieren lassen, ohne dass dafür ein klassisches Textverarbeitungsprogramm notwendig ist.

Im RoWaWiki nutze ich Markdown vor allem für einfache, langlebige Dokumentationen, Notizen und technische Aufzeichnungen.

Was ist Markdown?

Markdown ist eine einfache Auszeichnungssprache für strukturierten Text. Formatierungen werden direkt mit leicht lesbaren Zeichen im Text geschrieben und können später von geeigneten Programmen dargestellt oder weiterverarbeitet werden.

Alberts Tipp: Markdown muss man nicht auswendig können. Man muss nur wissen, wo man nachschauen kann. Rein zufällig bist du ja nicht gerade hier. 😏

Wofür nutze ich Markdown?

Markdown nutze ich vor allem dann, wenn Inhalte einfach, übersichtlich und langfristig lesbar dokumentiert werden sollen.

Typische Einsatzbereiche sind:

Projektdokumentationen
Arbeitsprotokolle
technische Notizen
Anleitungen
Zusammenfassungen
Festlegungen und Entscheidungen

Grundlagen

Tabellen

Tabellen lassen sich in Markdown mit senkrechten Strichen | und einer Trennzeile für die Überschriften erstellen.

| Bereich | Verwendung |
| --- | --- |
| Dokumentation | Wissen festhalten |
| Arbeitsprotokoll | Arbeitsschritte dokumentieren |
| Anleitung | Vorgehensweisen beschreiben |

Meine Praxis

Dateiendung

Markdown-Dateien verwende ich mit der Dateiendung:

.md

Beispiel:

20260810_0309_Markdown_Dokumentation_V1.0.md

Dateibenennung

Für neu erstellte Dokumentationsdateien verwende ich grundsätzlich ein einheitliches Schema:

yyyymmdd_hhmm_beschreibung

Dabei bedeuten:

yyyy – Jahr
mm – Monat
dd – Tag
hh – Stunde
mm – Minute
beschreibung – kurze, sprechende Beschreibung des Inhalts

Beispiel:

20260810_0309_Markdown_Dokumentation_V1.0.md

Durch das vorangestellte Datum und die Uhrzeit werden die Dateien bereits über ihren Namen chronologisch sortiert.

Verwendete Programme

Markdown-Dateien sind reine Textdateien und können mit unterschiedlichen Texteditoren bearbeitet werden.

Für meine Arbeit verwende ich hauptsächlich:

Notepad++ – für schnelle und unkomplizierte Bearbeitung
Visual Studio Code – insbesondere für Entwicklungsprojekte und umfangreichere Dokumentationen

Da Markdown ein reines Textformat ist, bleiben die Dateien unabhängig von einem bestimmten Programm lesbar und bearbeitbar.

Typische Einsatzbereiche

Markdown verwende ich vor allem für Inhalte, bei denen der Text und seine Struktur wichtiger sind als eine aufwendige Seitengestaltung.

Typische Einsatzbereiche sind:

Projektdokumentationen
technische Dokumentationen
Arbeitsprotokolle
Anleitungen und Schritt-für-Schritt-Beschreibungen
Festlegungen und Entscheidungen
Zusammenfassungen
Notizen und Wissenssammlungen
README-Dateien in Entwicklungsprojekten

Markdown eignet sich für diese Aufgaben besonders gut, weil die Dateien einfach aufgebaut, schnell bearbeitet und langfristig auch ohne spezielle Software lesbar sind.

Kurzreferenz

Die wichtigsten Markdown-Auszeichnungen auf einen Blick:

Zweck	Markdown
Überschrift 1	`# Überschrift`
Überschrift 2	`## Überschrift`
Fett	`Text`
Kursiv	`Text`
Fett und kursiv	`Text`
Ungeordnete Liste	`- Eintrag`
Nummerierte Liste	`1. Eintrag`
Link	`[Text](https://example.com)`
Bild	`![Alternativtext](bild.jpg)`
Zitat	`> Text`
Code im Text	`Code`
Trennlinie	`—`

Weiterführende Hinweise

Diese Seite ist als persönliche Markdown-Kurzreferenz gedacht und wird bei Bedarf erweitert.

Neue Markdown-Funktionen oder Beispiele werden ergänzt, wenn sie in der praktischen Arbeit tatsächlich benötigt werden.