Docsify: سرویسی اپن‌سورس برای ایجاد داکیومنتیشن با استفاده از مارک‌داون

Docsify: سرویسی اپن‌سورس برای ایجاد داکیومنتیشن با استفاده از مارک‌داون

اگر قصد دارید تا یک پلاگین رایگان، فریمورک یا اسکریپت اپن‌سورس ایجاد کنید، مسلماً به داکیومنتیشن احتیاج خواهید داشت به طوری که مستندسازی هم به سود خودتان است و هم به کسانی که می‌خواهند از سرویس شما استفاده کنند کمک می‌کند. در عین حال نیاز به توضیح نیست که ایجاد داکیومنتیشن می‌تواند کاری زجرآور باشد و شاید همین مسئله است که باعث گردیده بسیاری از دولوپرها عطای مستندسازی را به لقایش ببخشند!

Docsify ابزاری اپن‌سورس است که به صورت دینامیک فایل‌های مارک‌داون را لود کرده و آن‌ها را خیلی اصولی به عنوان وب‌پیج نمایش می‌دهد. برای استفاده از این سرویس لازم است که ابتدا یک فایل index.html ایجاد کنید، سپس می‌توانید آن را روی گیت‌هاب آپلود کرده و یا بر روی سرور اختصاصی خود میزبانی کنید و از آنجا به بعد شما فقط برای هر صفحه کدهای مارک‌داون می‌نویسید و از آن‌ها به عنوان داکیومنت‌های اصلی خود استفاده می‌کنید (کل فرایند کار با جزئیات در راهنمای سایت توضیح داده‌ شده و بنابراین بهتر است قبل از هر چیز، نگاهی به آن بیندازید.)

با یادگیری نحوهٔ کار با ابزار داکسیفای می‌توانید با استفاده از مارک‌داون یا اچ‌تی‌ام‌ال ویژگی‌های دیگری به مستندات خود اضافه کنید که این ویژگی‌ها شامل نوار نَویگیشن سفارشی و حتی کاور صفحه به همراه لوگوی پروژهٔ خودتان می‌شود. این ابزار همچنین تعدادی تِم رایگان هم دارا است که اگر می‌خواهید روی لی‌اوت‌های از پیش طراحی شده کار کنید، می‌توانید از آن‌ها استفاده نمایید.

تمام اطلاعات پایهٔ مربوط به سِتاپ و دانلود فایل‌ها بر روی گیت‌هاب در دسترس هستند مضاف بر اینکه می‌توانید یک دموی زنده هم بر روی صفحهٔ اصلی سایت این ابزار اپن‌سورس مشاهده کنید و اگر از آن لی‌اوت خوشتان آمد، می‌توانید از همان قالب استفاده کرده و از طریق داکسیفای به صورت ۱۰۰٪ رایگان آن را پیاده‌سازی کنید.