thlorenz/doctoc
Doctoc
doctoc ist ein Markdown-Inhaltsverzeichnis-Generator und Dateiprozessor, der darauf ausgelegt ist, automatisch verlinkte Listen von Überschriften innerhalb von Markdown-Dokumenten zu erstellen und zu aktualisieren. Es fungiert als Dokumentationstool für Git-Repositories, das lokale Verzeichnisse scannt, um sicherzustellen, dass die Navigation über eine Sammlung von Dateien hinweg konsistent bleibt.
Das Tool bietet einen GitHub-kompatiblen Anker-Generator, der Überschriften-Links so formatiert, dass sie den spezifischen Anforderungen von GitHub und ähnlichen Hosting-Plattformen entsprechen. Es verwaltet Updates durch das Auffinden von Marker-Kommentaren, um bestehende Inhaltsverzeichnisse zu ersetzen, ohne andere Dokumentinhalte zu überschreiben.
Das Projekt deckt die rekursive Verzeichnisverarbeitung ab, die es ermöglicht, verschachtelte Ordner zu scannen und Updates auf alle kompatiblen Dateien anzuwenden. Es enthält zudem Inhaltsfilterung und Eintragskontrolle, um spezifische Überschriften oder Dateien basierend auf Verschachtelungsebenen oder Metadaten-Tags auszuschließen.
Ein Konsistenz-Validierungs-Dienstprogramm ermöglicht es dem Tool zu prüfen, ob Dateien veraltet sind, ohne sie zu modifizieren, was die Integration in automatisierte Dokumentations-Workflows erleichtert.
Features
- Automatic Table of Contents - Automatically generates navigational outlines based on the heading hierarchy of Markdown documents.
- Anchor Links - Generates navigation identifiers that ensure compatibility with the anchor requirements of hosting providers.
- Markdown Processors - Provides a recursive processor that scans and transforms Markdown documents to maintain consistent navigation and formatting.
- Markdown Documentation - Automates the creation and maintenance of tables of contents for large sets of Markdown documentation.
- Platform Anchor Generators - Provides GitHub-compatible anchor generation to ensure navigation links function correctly on hosting platforms.
- TOC Refresh Utilities - Refreshes existing tables of contents by locating marker comments to prevent duplicate entries.
- Git Documentation Utilities - Scans local Git directories to ensure all Markdown files have consistent and current navigation.
- RegEx Heading Extractors - Uses regular expressions to identify heading levels and extract structure for table of contents generation.
- Markdown Content Structures - Manages navigation for complex directory structures through recursive processing and content filtering.
- Content Consistency Validators - Checks if document headings match the existing table of contents to signal required updates without modifying files.
- TOC Generation - Validates the consistency of the generated table of contents against the actual document headings.
- TOC Content Filters - Excludes specific headings or files from the generated table of contents using specialized markup tags.
- TOC Entry Controllers - Controls which headings appear in the table of contents based on nesting levels and minimum length.
- GitHub Repository Utilities - Provides utility functions to ensure Markdown navigation links are compatible with GitHub's repository structure.
- Documentation Automation - Integrates table of contents generation into build pipelines to keep navigation in sync with heading changes.
- Recursive Directory Processing - Traverses folder hierarchies to apply table of contents updates across entire project directories.
- Markdown File Processors - Recursively scans directories to apply table of contents generation to all compatible Markdown files.
- Recursive Directory Traversers - Recursively walks directory trees to locate all markdown files for batch processing.
- Marker-Based Injection Utilities - Implements programmatic updates of documentation by injecting table of contents between predefined marker comments.
- Markdown Tools - Generates table of contents for markdown files.
