DavidAnson/markdownlint
کاربرد:
این ابزار یک لینتر برای فایل‌های Markdown و CommonMark است که با استفاده از Node.js، سبک نوشتاری و ساختار فایل‌های مارک‌داون رو بررسی می‌کنه و از بروز خطاها یا ناهماهنگی‌ها جلوگیری می‌کنه. ️
در چه شرایطی بهتره استفاده شود؟
وقتی داری روی پروژه‌های مستندسازی، وبلاگ‌نویسی، یا همکاری تیمی با فایل‌های مارک‌داون کار می‌کنی، استفاده از این ابزار به حفظ یکدستی و کیفیت بالای کد کمک می‌کنه.
همچنین در محیط‌های توسعه‌ای که از CI/CD استفاده می‌کنند، می‌تونه به صورت خودکار قبل از ادغام کد، مستندات رو بررسی کنه.
چند مثال از موارد استفاده
- بررسی اینکه تمام عناوین با فاصله مناسب نوشته شدن.
- اطمینان از استفاده صحیح از لیست‌ها و تورفتگی‌ها.
- جلوگیری از استفاده از HTML خام در متن مارک‌داون (در صورت تمایل).
- یکدست کردن استفاده از خط‌های خالی بین بلوک‌ها.
- ادغام با VS Code یا GitHub Actions برای بازبینی خودکار.
- ##markdown
- ##linter
- ##NodeJS
- ##documentation
- ##CI
- ##code
- ##static
- ##developer
- ##writing
- ##automation