ekalinin/github-markdown-toc
Github Markdown Toc
Dieses Projekt ist ein Kommandozeilen-Tool zur Automatisierung der Erstellung und Pflege von Inhaltsverzeichnissen in Markdown-Dateien. Es fungiert als statischer Dokumentationsprozessor, der Dokumentüberschriften parst, um hierarchische Navigationslisten zu generieren, die dann direkt in die Quelldateien eingefügt werden.
Das Tool zeichnet sich dadurch aus, dass es sowohl lokale Dateien als auch Remote-Netzwerk-Streams als Eingabequellen unterstützt. Es nutzt markerbasierte Inhaltsaktualisierungen, um bestehende Navigationsabschnitte ohne manuelle Bearbeitung zu aktualisieren, und enthält Authentifizierungsunterstützung für Remote-Anfragen, um Ratenbegrenzungen beim Abrufen externer Dokumentationen zu umgehen.
Über die grundlegende Generierung hinaus übernimmt das Tool die Normalisierung von Überschriften in URL-sichere Anker-Slugs und verwaltet die strukturellen Metadaten, die für eine konsistente Dokumentenindizierung erforderlich sind. Es zielt darauf ab, Dokumentations-Workflows durch die Automatisierung der Pflege von Navigationsstrukturen in Repository-Dateien und verteilten technischen Inhalten zu optimieren.
Features
- Automatic Table of Contents - Automatically generates, inserts, and refreshes formatted tables of contents by parsing document headings.
- Marker-Based Injection Utilities - Maintains persistent navigation sections by injecting content between predefined start and end markers in source files.
- Table of Contents Generators - Parses markdown files via command-line to create and inject hierarchical navigation lists based on headings.
- Hierarchical Heading Generation - Calculates indentation levels and generates URL-safe anchor slugs to structure document headings into a hierarchical tree.
- Markdown Documentation - Automates the creation and updating of table of contents sections within markdown files to improve navigation.
- README Generators - Automates the maintenance of navigation structures within repository documentation files to improve reader accessibility.
- GitHub Repository Utilities - Provides utilities to generate structured navigation lists for project README files in GitHub repositories.
- Static Documentation Generators - Acts as a text-parsing engine that extracts document structure from various sources to generate formatted navigation links.
