VitePress Sidebar
Ein VitePress-Plugin, das die Seitenleiste aus den Dateien auf der Festplatte aufbaut. Sortierung, Titel, Filter und Einstellungen je Ordner ersetzen ein von Hand gepflegtes Menü.
Über dieses Projekt
VitePress Sidebar baut die Seitenleiste einer VitePress-Site aus dem Ordnerbaum, sodass eine Dokumentationsseite kein handgeschriebenes Menü mehr mitschleppt, das bei jeder neuen, umbenannten oder verschobenen Seite angefasst werden muss. Es umschließt die VitePress-Konfiguration mit einem Funktionsaufruf und lässt alles andere unangetastet.
Das erzeugte Menü ist einstellbar und nicht festgelegt. Titel können aus der Dateiüberschrift oder dem Frontmatter kommen, Ordner lassen sich sortieren, bis zu einer gewählten Tiefe einklappen, filtern, umbenennen oder ausschließen, und ein Ordner kann eine eigene Konfigurationsdatei tragen, wo er sich vom Rest unterscheiden muss. Mehrere Seitenleisten und Frontmatter-Überschreibungen funktionieren so, wie VitePress sie dokumentiert — nichts, was das Standard-Theme ohnehin kann, geht verloren.
Es ist in TypeScript geschrieben, bringt eigene Deklarationen mit, fügt dem Build wenig und der Seite gar nichts hinzu und folgt der aktuellen VitePress-Version. Jede Option ist mit einem Beispiel dokumentiert.
Funktionen
Dokumentationsseite
TypeScript-Typen
Mehrsprachig
Durch Tests geprüft