TOC in README.md erstellen mit VSCode
TOC steht für Table of Contents (aka Inhaltsverzeichnis). Jedes grössere README Markdown File in einem git Repo sollte über ein TOC verfügen.
Doch die Pflege eines TOC sowie die initiale Erstellung ist nicht sehr handlich, du musst für jeden einzelnen Titel in der richtigen Einrückung (damit die Titelanordnung stimmt) folgender Inhalt eintippen, obwohl du diese ja bereits als Titel in der Markdown Datei definiert hast:
- [Table of Contents](#table-of-contents)
- [Verbesserungen](#verbesserungen)
- [Anpassungen innerhalb dieses Repositories](#anpassungen-innerhalb-dieses-repositories)
- [CI Pipeline](#ci-pipeline)
damit dann dieses schöne Inhaltsverzeichnis entsteht:
Doch es gibt einen Weg, wie du ohne die Arbeit doppelt zu machen (jeden Titel zweimal schreiben 😒), einfach und schnell aus deinem Markdown ein TOC erstellen und später auch einfach wieder aktualisieren kannst.
In der IDE VSCode kannst du dazu die Extension Auto Markdown TOC installieren. Es gibt duzende solche Extensions, lass mich wissen wenn du ein besseres findest. 😃
Wenn du die Extension installiert hast, kannst du anschliessend direkt aus VSCode in deinem Markdown File ein TOC generieren lassen:
Viel Spass damit!