RoWaWorld

Eine ältere Version des Dokuments wurde geladen! Beim Speichern wird eine neue Version des Dokuments mit diesem Inhalt erstellt.

<WRAP rww-subpage-heading>
====== Markdown ======
</WRAP>

<WRAP rww-back>
[[dokumentation_wissen:start|←]] [[dokumentation_wissen:start|Dokumentation & Wissen]]
</WRAP>

</WRAP>

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.

<WRAP rww-albert-text>
**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. 😏
</WRAP>

</WRAP>

===== 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 =====
{{:rww:infografiken:infografik_markdown_grundlagen.png|Infografik – Markdown-Grundlagen}}

==== Überschriften ====

Überschriften strukturieren ein Markdown-Dokument. Sie werden mit dem Zeichen ''#'' gekennzeichnet.

<code markdown>
# Überschrift 1
## Überschrift 2
### Überschrift 3
#### Überschrift 4
</code>

==== Textauszeichnung ====

Markdown bietet einfache Möglichkeiten, Text hervorzuheben.

<code markdown>
**fett**
*kursiv*
***fett und kursiv***
</code>

==== Listen ====

Markdown unterstützt ungeordnete und nummerierte Listen.

=== Ungeordnete Liste ===

<code markdown>
- Erster Punkt
- Zweiter Punkt
- Dritter Punkt
</code>

=== Nummerierte Liste ===

<code markdown>
1. Erster Schritt
2. Zweiter Schritt
3. Dritter Schritt
</code>

==== Links ====

Links werden in Markdown aus dem sichtbaren Linktext und der Zieladresse aufgebaut.

<code markdown>
[OpenAI](https://openai.com)
</code>

Die allgemeine Schreibweise lautet:

<code markdown>
[Linktext](https://example.com)
</code>

==== Bilder ====

Bilder werden in Markdown ähnlich wie Links eingebunden. Vor der eckigen Klammer steht zusätzlich ein Ausrufezeichen.

<code markdown>
![Alternativtext](bilder/mein-bild.jpg)
</code>

Ein Bild aus dem Internet kann über seine Adresse eingebunden werden:

<code markdown>
![Alternativtext](https://example.com/bild.jpg)
</code>

===== Nützliche Elemente =====

==== Code ====

Kurze Codebestandteile können innerhalb eines normalen Textes mit einfachen Backticks gekennzeichnet werden.

<code markdown>
Der Befehl `git status` zeigt den aktuellen Git-Status.
</code>

Für längere Codeblöcke werden drei Backticks verwendet.

==== Zitate ====

Zitate werden in Markdown mit dem Zeichen ''>'' am Zeilenanfang gekennzeichnet.

<code markdown>
> Das ist ein Zitat.
</code>

Auch mehrzeilige Zitate sind möglich:

<code markdown>
> Dokumentation hilft nicht nur heute.
>
> Sie hilft vor allem dann, wenn man sich später fragt:
> „Wie hatte ich das damals eigentlich gemacht?“
</code>

==== Tabellen ====

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

<code markdown>
| Bereich | Verwendung |
| --- | --- |
| Dokumentation | Wissen festhalten |
| Arbeitsprotokoll | Arbeitsschritte dokumentieren |
| Anleitung | Vorgehensweisen beschreiben |
</code>

==== Trennlinien ====

Eine horizontale Trennlinie kann in Markdown mit drei oder mehr Bindestrichen erzeugt werden.

Sie eignet sich dazu, größere Inhaltsbereiche optisch voneinander zu trennen.

===== Meine Praxis =====

==== Dateiendung ====

Markdown-Dateien verwende ich mit der Dateiendung:

Beispiel:

<code>
20260810_0309_Markdown_Dokumentation_V1.0.md
</code>

==== Dateibenennung ====

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

<code>
yyyymmdd_hhmm_beschreibung
</code>

Dabei bedeuten:

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

Beispiel:

<code>
20260810_0309_Markdown_Dokumentation_V1.0.md
</code>

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:

===== 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.

Zusammenfassung