Codeberg's Wiki via Markdown

Codeberg’s aufgemotztes Gitea UI stellt allen Nutzern ein besonders GIT Repository bereit:
Das Wiki-Repo.

Und mit ein paar Markdown Dateien bildet sich automatisch eine ganze Wiki-Seite im eigenen Projekt-Bereich.

Lange Zeit spielte ich mit Jekyll herum um parallel zu den Postings auch spezielle Seiten verwalten zu können. Im Blog sind das die Suche und alles, was im Bereich Dokus und Infos zu finden ist.

Auf der Projekt-Hautseite wollte ich ursprünglich ein paar konzeptionelle Details zum GATE Framework veröffentlichen … doch weil mir das alles nicht so recht gefiel, blieb auch die Motivation aus hier weiterzumachen.

Und dann fiel mir wieder ein:

Codeberg bietet doch Wiki-Pages an!

Die Wiki-Funktion muss in den Einstellungen eines Projekt aktiviert sein, und wer dann im Bereich namens “MYORG” im Projekt “MYPROJECT” die URL
https://codeberg.org/MYORG/MYPROJECT.wiki.git per git klont, kann sich seine Wiki-Seiten per Markdown zusammenschustern und bekommt das Design von Codeberg verpasst, was besser zum Thema Coding und Doku passt, als experimentelle Eigenerfindungen auf privaten Homepages.

Home, Sidebar und Footer

Es gibt 3 besondere Dateinamen, denen eine spezielle Bedeutung zukommt.

• Home.md ist die Startseite, was wir im Web als index.md bzw. index.html kennen.
• _Sidebar.md wird in erster Line als Navigations-Menü immer in einer Box am Rande der Seite (neben dem eigentlichen Content) eingeblendet.
• _Footer.md wird jeder Seite am Ende angefügt und eignet sich hervorragend für Copyright und Impressum-Verweise, oder auch für den “Spruch des Tages”.

Kurz gesagt: Mit Home startet alles, und _Sidebar sowie _Footer werden permanent rechts bzw. unterhalb der eigentlichen Seite eingeblendet.

Weitere Seiten mit Verlinkung

Nun kann man auch neue .md Dateien mit Markdown Content anlegen. Verlinkt werden diese wie üblich über [Link-Text](Linkziel), wobei das Ziel des Links nicht als URL, sondern als reiner Dateinamen (aber ohne .md) angegeben wird.

Eine Datei namens additional_info.md wird per

[Addition Information](additional_info)

verlinkt.

Fazit

Wer also etwas Text zu seinem Codeberg Projekt schreiben will, ist mit dem internen Wiki an der richtigen Adresse.

Zusätzlich zur “nativen” Bearbeitung über git lässt sich der Text auch online bearbeiten.
Sogar die Freigabe des Wikis ist möglich, damit jeder Benutzer etwas beisteuern oder ändern kann.

In Summe also ein absoluter Daumen-hoch für Codeberg’s Wiki Pages.