Manchmal liegen größere Markdown-Dateien in GITEA. Die Darstellung ist dann relativ unübersichtlich, weil sie im Browser als eine große Seite angezeigt werden und man nicht so ohne weiteres direkt in das gewünschte Kapitel springen kann.

Bei GITEA gibt es eine einfache Möglichkeit, ein Inhaltsverzeichnis anzuzeigen. Dies erleichtert die Navigation wesentlich!

Aktivieren via Markdown-Header

Oben in der Markdown-Datei muß ein Header eingefügt werden mit diesem Inhalt:

1
2
3
4

---
gitea: none
include_toc: true
---

Dabei bedeutet:

• gitea: none: Markdown-Header in Gitea nicht anzeigen
• include_toc: true: Inhaltsverzeichnis anzeigen

Darstellung mit Inhaltsverzeichnis

Eingeklappt

Nach der Aktivierung des Inhaltsverzeichnisses wird das Markdown-Dokument dann so dargestellt:

Ausgeklappt

Darstellung ohne “gitea:none”

Links

• Adding a TOC to a markdown file
• Gitea: howto add a TOC in a markdown file

Historie

• 2022-08-05: Erste Version