مستندسازی با استفاده از فایلهای Markdown در Docsify

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

این یک سایت معمولی استاتیک نیست و نیازی به صفحات HTML / CSS استاتیک ندارد.در عوض، فایل های Markdown را به صورت داینامیک بارگذاری می شوند و آنها را به عنوان صفحات وب نمایش می دهد.صفحه اصلی Docsify را برای پیش نمایش طرح، همراه با جزئیات بیشتر تنظیم کنید.لازم است فایل خود را به صورت index.html ایجاد کنید که بعدا میتواند به صفحات GitHub آپلود شود یا در سرور خودتان میزبانی شود. از آنجا، شما فقط فایل های Markdown برای هر صفحه را بنویسید و از آنها به عنوان اسناد اولیه خود استفاده کنید.

کل فرایند مشخص شده در جزئیات راهنمای سریع به طور کامل شرح داده شده است.این همه می تواند از طریق npm اجرا شود.پس واقعا کمک می‌کند تا command prompt خود را بشناسید یا حداقل مایل باشید یاد بگیرید.امکان ساخت یک فایل HTML خام برای خودتان وجود دارد و فقط الگو را از راهنمای نصب Docsify کپی و Paste کنید.اما من ترجیح میدهم اینکار را دایتامیک انجام دهم چراکه شدیدا در صرفه‌جویی وقت موثر است. آیا این خود یک امتیار محسوب نمیشود؟!

وقتی که شما سیستم Docsify را یاد می گیرید، می‌توانید از ویژگی های Markdown یا HTML خام استفاده کنید.این ویژگی ها شامل نوار navigator سفارشی و حتی پوشش صفحه خود با لوگوی پروژه شما است.Docsify حتی با یک دسته از تم های رایگان بسته بندی می شود که اگر شما خواستید میتوانید پوسته های پیش طراحی شده را به کار ببرید. ویا می توانید از گالری showcase خود دیدن کنید تا ببینید کدام پروژه ها برای مدارک خود از Docsify استفاده می‌کنند.

Docsify example documentation

می توان تمام اطلاعات مربوط به راه اندازی اولیه و بارگیری فایل را در GitHub پیدا کرد.شما همچنین میتوانید نسخه ی نمایشی زنده را در صفحه مستندات اصلی Docsify که کاملا در Docsify اجرا میشود، ببینید!

منبع : *

سهند کاظم‌زاده

سلام من سهند هستم یکی از نویسندگان کدفرند،به برنامه نویسی شدیدا علاقه دارم

همه مطالب این نویسنده

تاکنون هیچ نظری ثبت نشده است