وقتی روی پروژه‌ها کار می‌کنیم، خواه از نظر کارایی غول‌پیکر باشند یا صرفاً به این دلیل که در معرض مشتریان قرار می‌گیرند، می‌خواهیم مستندسازی شوند تا سایر توسعه دهندگان یا مشتریان بتوانند بدون هیچ مشکلی آنها را پیدا کنند.
اغلب، این اسناد پراکنده است، در یک تلاقی که یافتن آن غیرممکن است گم می شود… یا به سادگی وجود ندارد!
امروز می خواهیم ببینیم که چگونه Docusaurus به سادگی به ما در مدیریت این امر کمک می کند!
Docusaurus چیست؟
Docusaurus یک ابزار متن باز است که امکان ایجاد اسناد از فایل های Markdown را فراهم می کند.
پس از کامپایل و استقرار، تمام فایل‌های نشانه‌گذاری شما را در معرض مستندات فنی زیبا قرار می‌دهد بدون اینکه نیازی به اتلاف وقت در تنظیمات متعدد داشته باشید. علاوه بر این، با ابزارها و نمونه هایی که از قبل وجود دارد، احتمال کمی وجود دارد که زمان را برای استقرار آن تلف کنید!
احمقانه است که چنین بگویم، اما در دراز مدت زمان زیادی را ذخیره می کند!
چرا docusaurus؟
هدف اصلی آن است که واقعا به سمت ایجاد سریع و آسان اسناد فنی و نه از یک سایت ثابت! که یک تفاوت بزرگ است.
ابزارهای دیگر (که قبلاً به آن اشاره کردم) بیشتر به سمت ایجاد یک سایت ثابت یا یک وبلاگ می‌روند، بنابراین عملکردها، به ویژه در مورد سازماندهی و ناوبری، کاملاً متفاوت هستند.
به عنوان مثال، Docusaurus دو نوار ناوبری را ارائه می دهد.
یکی در سمت چپ، برای پیمایش در موضوعات مختلف و موضوعات فرعی.
یکی در سمت راست، برای پیمایش بین نقاط مختلف و زیرنقاط اسناد فعلی.
نکته بسیار مفید دیگر، تحقیق مستقیماً در اسناد شما ادغام شده است! نیازی به جستجوی یک ماژول خارجی برای این کار نیست، در حال حاضر برای شما وجود دارد! همینطور برایبین المللی شدن و ادغام الف وبلاگ جنب!
من برای جزئیات ویژگی ها در آنجا توقف خواهم کرد زیرا تعداد کمی وجود دارد و ساده ترین راه این است که بروید و آنها را برای خودتان آزمایش کنید!
نتیجه
برای نتیجه گیری، Docusaurus واقعاً ابزاری است که شایسته آزمایش است زیرا همه چیزهایی را که برای خوشحال کردن شما نیاز دارید را دارد. ساده و موثر، می تواند به سرعت به متحد شما تبدیل شود تا اسناد تمام پروژه های شما را تسهیل کند.
حق حبس
امیدوارم این بتواند به تو کمکی کند! 🍺
