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

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

اگر قصد دارید تا یک پلاگین رایگان، فریمورک یا اسکریپت اپن‌سورس ایجاد کنید، مسلماً به داکیومنتیشن احتیاج خواهید داشت. داکیومنت کردن کارتان هم به سود خودتان است و هم به کسانی که می‌خواهند از سرویس شما استفاده کنند کمک می‌کند. با این‌ حال، ایجاد داکیومنتیشن به صورت آنلاین می‌تواند کار زجرآوری باشد اما خوشبختانه Docsify با ارائهٔ یک داکیونتیشن‌ساز رایگان که بر روی Markdown اجرا می‌شود، این کار را برای شما آسان‌تر از گذشته کرده‌ است.

Docsify یک سایت‌ساز معمولی استاتیک نیست و به صفحات استاتیک HTML/CSS احتیاجی ندارد و به جای آن به صورت پویا فایل‌های مارک‌داون را لود کرده و آنها را خیلی اصولی به عنوان وب‌پیج نمایش می‌دهد (می‌توانید از هوم‌پیج لینک فوق برای دیدن پیش‌نمایشی از لی‌اوت به همراه جزئیات بیشتری راجع به سِتاپ آن دیدن کنید).

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

کل فرایند کار با جزئیات در راهنمای سایت توضیح داده‌ شده و بنابراین بهتر است قبل از همه چیز، نگاهی به آن بیندازید. کل این پروسه از طریق npm قابل‌اجرا می‌باشد و بنابراین آشنایی با کامندلاین و یا حداقل یادگیری آن کمک شایانی به شما می‌کند.

همچنین این امکان وجود دارد که خودتان فایل HTML خام تولید کرده و فقط قالب را از قسمت راهنمای سِتاپ داکسیفای کپی/پیست کنید؛ اما پیشنهاد می‌شود که این کار را به صورت پویا انجام دهید چرا که موجب صرفه‌جویی در وقت‌تان می‌شود.

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

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

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

منبع


نهال سهیلی‌فر