Die Inspiration

Bei der Suche nach Inspiration für mein GitHub-Profil bin ich auf das README von @koaning gestoßen. Statt der üblichen Liste mit Badges und Stats nutzt er eine Tree-Struktur, die alle seine Projekte, Webseiten und Links elegant organisiert.

Warum ein Tree?

Die Tree-Darstellung hat mich aus zwei Gründen überzeugt:

Die hierarchische Struktur ist intuitiv verständlich und übersichtlich – selbst Menschen ohne Tech-Background können sofort erkennen, wie Projekte zusammenhängen und was ich mache.

Entwickler erkennen sofort die Referenz zum tree-Befehl aus der Kommandozeile und müssen hoffentlich ein wenig schmunzeln, diese im Web zu sehen ;)

Ein kleiner Ausschnitt:

...
├── 🎓 Uni
│   ├── Rust Tutor
│   └── THA
├── 🐙 VCS
│   ├── Codeberg
│   ├── GitHub
│   └── GitLab
├── 🔬 Experiments
│   └── Notebooks
...

Umsetzung

Statt den Tree manuell zu pflegen, habe ich ein Nushell-Script entwickelt, das den Prozess vollständig automatisiert. Ich organisiere meine Links in einer Ordnerstruktur in dem Repo. Jede Datei enthält einen Link als Inhalt, und die Ordnerstruktur spiegelt genau die gewünschte Hierarchie wider. Das Nushell-Script führt dann eine rekursive Tiefensuche (DFS) durch und erstellt daraus einen Tree in HTML, den ich in die README schreiben kann.

Als kleinen Bonus habe ich noch lefthook integriert, sodass bei jedem Commit automatisch eine neue README erstellt wird. Bei Anpassungen muss ich also nur den Ordner anpassen, eine neue Datei mit Link als Inhalt ablegen und Commiten, e voilà habe ich eine neue README.

Ergebnis

Das Ergebnis ist auf meinem GitHub-Profil zu sehen :)