jonschlinkert/markdown-toc
کاربرد:
این ابزار یک جدول محتویات (TOC) برای فایل‌های مارک‌داون مثل README ایجاد می‌کند. هم به صورت API و هم CLI کار می‌کند و با استفاده از کتابخانه Remarkable، مارک‌داون رو تجزیه و تحلیل می‌کنه.
در چه شرایطی بهتره استفاده شود؟
وقتی می‌خوای یک مستند فنی، ریدمی یا مقاله مارک‌داون داشته باشی که ساختار منظمی از عناوین داره و می‌خوای خواناییش رو با یک فهرست پویا افزایش بدی. مناسب پروژه‌های اوپن‌سورس، مستندات تیمی و ابزارهای ساخت خودکار.
چند مثال از موارد استفاده
اضافه کردن خودکار فهرست به فایل README.md یک پروژه گیت‌هاب
به‌روزرسانی فهرست بعد از تغییر عناوین در یک مقاله طولانی
استفاده در CI/CD برای تولید مستندات استاندارد در هر ریلیز
- ##markdown
- ##toc
- ##documentation
- ##cli
- ##api
- ##developer
- ##open
- ##static
- ##github
- ##remarkable