3choff/docs-miner
این یک افزونهٔ VSCode است که به تو کمک میکنه تا مستندات مارکداون از صفحات وب و مخازن گیتهاب تولید کنی.
کاربرد:
وقتی میخوای اطلاعات یک صفحهٔ وب یا یک پروژهٔ گیتهاب رو به صورت ساختاریافته و قابل جستجو داشته باشی، این ابزار به صورت خودکار یک فایل markdown میسازه و توی محیط کدنویسیات قرارش میده. ️
در چه شرایطی بهتره استفاده شود؟
- وقتی داری روی یک پروژهٔ اوپنسورس کار میکنی و نیاز به مستندات محلی داری
- وقتی میخوای تغییرات یک ریپازیتوری گیتهاب رو دنبال کنی و نسخهٔ آفلاین مستندات رو داشته باشی
- وقتی تیم تو نیاز به مستندات یکپارچه و خودکار از چند منبع مختلف داره
چند مثال از موارد استفاده:
- تولید خودکار README از یک صفحهٔ داکیومنتاسیون رسمی مثل React یا Vue
- ذخیرهٔ نسخهٔ بهروز از مستندات یک API بدون نیاز به کپیدستی
- استخراج محتوای آموزشی از یک بلاگ فنی و تبدیلش به فایل مارکداون برای مطالعهٔ آفلاین
- #docs
- #VSCodeExtension
- #Markdown
- #WebScraper
- #GitHub
- #DevTools
- #Automation
- #Productivity
- #CodeDocs
- #OpenSource