3. Dateien & Markdown
Dauer: ca. 30 min Input, 15 min Übungen
Frage: Wie lege ich Dateien in meinem Projekt an und bearbeite sie?
Lernziele:
- Eine Datei im Browser anlegen und bearbeiten
- Erklären, was ein Commit ist, und eine gute Commit-Nachricht schreiben
- Texte mit Markdown formatieren (Überschriften, Listen, Links, Hervorhebungen)
GitLab bietet zwei Editoren im Browser:
- die Web IDE: ein voller Editor wie VS Code, mit Dateiliste und mehreren Dateien gleichzeitig;
- den Einzeldatei-Editor: mit weniger Funktionen, immer genau eine Datei.
Wir nutzen hier die Web IDE. Der Einzeldatei-Editor ist in einem Kasten weiter unten beschrieben. Er reicht für kleine Änderungen und ist der Weg, wenn die Web IDE auf eurer Instanz abgeschaltet ist.
Die Web IDE öffnen
Unser Projekt ist noch leer. Auf der Projektseite steht unter „The repository for this project is empty“ eine Reihe von Buttons.
- Auf „New file“ klicken. Es öffnet sich die Web IDE.
- Links steht die Dateiliste, rechts der Bereich mit Tabs für geöffnete Dateien. Den Willkommens-Tab könnt ihr über das „x“ schließen.
Die Web IDE ist standardmäßig dunkel. Umstellen: Zahnrad unten links → Themes → Color Theme → z. B. „GitLab Light“.
Wozu eine README?
Die README ist das Aushängeschild eures Projekts. Sie steht auf der Projektseite direkt unter der Dateiliste und ist das Erste, was andere sehen. Eine gute README beantwortet die Fragen, die jemand hat, der das Projekt zum ersten Mal öffnet:
- Worum geht es? Ein, zwei Sätze zum Zweck des Projekts.
- Was ist drin? Welche Dateien oder Ordner gibt es, und wofür sind sie da?
- Wie nutze ich es? z. B. wo man anfängt oder was man braucht.
- Wer ist zuständig? Ansprechperson oder Kontakt.
- Wie kann ich mitmachen? und ggf. unter welcher Lizenz der Inhalt steht.
Die README hilft auch euch selbst: Wer ein Projekt nach einem halben Jahr wieder öffnet, weiß oft nicht mehr, was darin steckt.
Eine Datei anlegen
- Mit der Maus über die (leere) Dateiliste fahren. Oben erscheint ein Icon „Blatt mit Plus“ (New File).
- Darauf klicken,
README.mdeintippen und mit Enter bestätigen. - Die Datei öffnet sich rechts in einem Tab.
Eine Überschrift beginnt mit ein bis sechs #, danach kommt ein Leerzeichen. Die Zahl der # gibt die Ebene an, 1 ist die wichtigste.
# Ebene 1
## Ebene 2
### Ebene 3Beschreibt in der README.md, was in eurem Forschungstagebuch stehen wird.
Zum Beispiel:
# Forschungstagebuch
Dieses Projekt enthält unser Forschungstagebuch.
Jeder Tag bekommt eine eigene Datei.
Wir schreiben alle Dateien in Markdown.Speichern: der Commit
Änderungen sind erst gespeichert, wenn ihr einen Commit macht. Ein Commit bündelt Änderungen an einer oder mehreren Dateien, zusammen mit einer Nachricht, dem Namen der Person und dem Zeitpunkt. Alle Commits nacheinander bilden die Historie des Projekts.
- Links auf das Icon Source Control klicken (eine Verzweigung, darauf eine Zahl mit der Anzahl der Änderungen).
- Oben eine Commit-Nachricht eintragen.
- Auf den Button zum Committen klicken (z. B. „Commit and push to ‘main’“). Fragt GitLab nach, bestätigen.
Eine Commit-Nachricht sagt kurz, was geändert wurde und gegebenenfalls warum. „README mit Projektbeschreibung ergänzt“ hilft später, „Update“ oder „asdf“ nicht. Mehr dazu: How to Write a Git Commit Message.
Zurück zum Projekt kommt ihr über den Button „GitLab“ unten links in der Web IDE und dann „Go to project“ (öffnet ggf. einen neuen Tab), oder über den Browser-Tab, in dem das Projekt noch offen ist.
So geht dasselbe ohne Web IDE, etwa wenn sie auf eurer Instanz abgeschaltet ist:
Neue Datei anlegen
- Auf der Projektseite über der Dateiliste, neben dem Branch-Namen
main, auf „+“ → „New file“ klicken. - Oben den Dateinamen mit Endung eintragen, z. B.
2026-11-10.md. - Inhalt schreiben.
Bestehende Datei bearbeiten
- Die Datei in der Dateiliste anklicken.
- „Edit“ → „Edit single file“ wählen.
Formatierungsleiste: Beim Bearbeiten einer bestehenden Datei gibt es über dem Textfeld Buttons für Fett, Kursiv, Durchgestrichen, Zitat, Code, Link, Aufzählung, nummerierte Liste, Checkliste, Tabelle und ausklappbarer Abschnitt (Collapsible section). Man muss die Markdown-Zeichen also nicht auswendig kennen: Text markieren, auf B klicken, und GitLab setzt die ** davor und dahinter. Ein Button rechts schaltet zwischen „No wrap“ und „Soft wrap“ um. Bei „Soft wrap“ werden lange Zeilen im Textfeld umgebrochen, an der Datei ändert das nichts.
Vorschau: Über dem Textfeld gibt es die Tabs „Write“ und „Preview“.
Speichern
- Auf „Commit changes“ klicken.
- Im Dialog die Commit message eintragen.
- Ziel: direkt auf den aktuellen Branch (
main) committen. Die Option „Commit to a new branch“ (mit „Create a merge request for this change“) brauchen wir erst später. - Mit „Commit changes“ bestätigen.
Über dasselbe „+“ kann man mit „Upload file“ auch Dateien vom eigenen Rechner hochladen.
Die Projektseite mit Inhalt
Wieder auf der Projektseite hat sich einiges geändert:
- Der Hinweis „repository is empty“ ist weg. Stattdessen steht dort eine Dateiliste, bisher mit
README.md. - Über der Liste steht der letzte Commit mit Nachricht, Person, Zeitpunkt und einer Kurzkennung.
- Eine Infospalte zeigt Kennzahlen wie die Anzahl der Commits und Branches. Sie sind auch Links.
- Unter der Dateiliste wird die README formatiert angezeigt, weil eine README im Hauptverzeichnis eine weit verbreitete Konvention ist.
- Legt eine neue Datei
2026-11-10.mdan (Datum anpassen) und schreibt 2–3 Sätze, was ihr heute gelernt habt. Nutzt dabei eine Überschrift, eine Liste und etwas Fettgedrucktes. - Committet mit einer guten Nachricht.
- Öffnet die Historie: über „History“ über der Dateiliste oder links Code → Commits. Klickt auf einen Commit. Grün ist hinzugefügt, rot entfernt.
# Überschrift 1
## Überschrift 2
**fett** und *kursiv*
- Listenpunkt
- noch ein Listenpunkt
1. erstens
2. zweitens
[Linktext](https://example.org)
- [ ] offene Aufgabe
- [x] erledigte Aufgabe
`Code im Satz`Ausführlich: GitLab Flavored Markdown.
Kernaussagen
- Dateien kann man komplett im Browser anlegen und bearbeiten, mit der Web IDE oder dem Einzeldatei-Editor.
- Ein Commit speichert Änderungen mit einer Nachricht in der Historie.
- Eine
README.mdim Hauptverzeichnis wird auf der Projektseite angezeigt.