jonschlinkert/markdown-toc
Markdown Toc
Markdown-toc هي أداة لإنشاء وصيانة جداول المحتويات داخل ملفات markdown. تعمل كواجهة سطر أوامر ومكتبة برمجية، مما يتيح الإنشاء المؤتمت لروابط التنقل المنظمة بناءً على تسلسل هرمي للعناوين في المستند.
تتميز الأداة بنظام حقن قائم على العلامات، والذي يسمح بالوضع الدقيق وتحديث كتل التنقل داخل الملفات الموجودة. وهي تتضمن خط أنابيب تحويل مخصصاً لتحويل نص العنوان إلى معرفات صديقة لـ URL، مما يضمن بقاء الروابط التي تم إنشاؤها متسقة وعاملة مع تطور التوثيق.
بعيداً عن الإنشاء الأساسي، يوفر المشروع مجموعة من أدوات التحليل التي تستخرج بيانات تعريف العنوان ومستويات التسلسل الهرمي. تدعم هذه الميزات سير عمل التوثيق المخصص، بما في ذلك القدرة على تصفية المحتوى، وتطبيق قيود العمق، والدمج مع محركات عرض markdown المختلفة لتسهيل صيانة التوثيق المؤتمتة.
Features
- Table of Contents Generators - Generates and injects structured table of contents navigation links based on document heading hierarchy.
- Document Parsing CLI Tools - Provides a command-line interface for automating table of contents maintenance using configurable insertion markers.
- Automatic Table of Contents - Injects generated tables of contents into markdown files using comment markers to define precise insertion points.
- Marker-Based Injection Utilities - Uses marker-based injection to precisely place and update generated content blocks within existing markdown files.
- Slugification Tools - Provides a transformation pipeline for slugifying heading text into URL-friendly identifiers for consistent link generation.
- Hierarchy Traversers - Implements recursive traversal of heading hierarchies to calculate nesting levels for structured navigation.
- README Section Injections - Automates the injection and refreshing of table of contents sections within project README files.
- Markdown Documentation - Maintains markdown documentation by automating the creation and updating of navigation structures.
- Utility Tools - Tool for generating tables of contents for Markdown files.
