WikiRabbit — ویکی مخزن
برای هر مخزن یک فضای مستندات Markdown مستقل از تاریخچهٔ Git دارید: صفحات با عنوان و slug، ویرایش با پیشنمایش، جستجو، تاریخچهٔ نسخه و امکان نمایش عمومی برای مخازن خصوصی. سقف تعداد صفحات بر اساس پلن مالک مخزن اعمال میشود.
۱. ورود و مسیر
- از صفحهٔ مخزن لینک Wiki را بزنید؛ نشانی: /repos/<repoId>/wiki
- هر صفحه: /repos/<repoId>/wiki/<slug> — slug از عنوان ساخته میشود (از جمله عنوان فارسی).
- برای ویرایش باید دسترسی commit (یا مالک) داشته باشید؛ بازدیدکنندگان عمومی فقط میخوانند.
- اگر wiki در تنظیمات مخزن غیرفعال باشد، بخش wiki در دسترس نیست (wikiEnabled).
۲. صفحات و ویرایش
- صفحه جدید: از دکمهٔ «صفحه جدید» یا مسیر /wiki/new.
- ویرایشگر دو ستونه: Markdown سمت چپ، پیشنمایش زنده سمت راست.
- پیشنویس خودکار: هنگام ویرایش، پیشنویس هر چند ثانیه ذخیره میشود (فقط برای شما تا انتشار).
- انتشار: با «انتشار صفحه» یا Ctrl+S نسخهٔ جدید در تاریخچه ثبت میشود؛ میتوانید «پیام تغییر» بنویسید.
- لینک داخلی: بنویسید [[نام صفحه]] تا به slug همان عنوان لینک شود.
نمونههای آماده
در خانهٔ wiki کارتهای «نمونههای آماده» وجود دارد (صفحهٔ اصلی، نصب، مشارکت، FAQ، API) — با یک کلیک صفحه با محتوای اولیه ساخته میشود و بعد ویرایش میکنید.
۳. نمایش عمومی Wiki
مالک مخزن از /repos/<repoId>/wiki/settings یا تنظیمات مخزن میتواند:
- WikiRabbit را برای مخزن فعال/غیرفعال کند.
- نمایش عمومی Wiki را روشن کند — حتی اگر مخزن خصوصی باشد، هر کسی با لینک میتواند صفحات را بخواند (بدون ویرایش و بدون دسترسی به کد).
اگر wiki عمومی نباشد، فقط اعضای مخزن و همکاران با دسترسی read میتوانند ببینند.
۴. تاریخچه و بازگردانی
- هر انتشار یک revision با شمارهٔ نسخه و پیام تغییر میسازد.
- از دکمهٔ «تاریخچه» در صفحه، نسخههای قبلی را ببینید.
- بازگردانی یک نسخهٔ قدیمی محتوای فعلی را جایگزین میکند (revision جدید ثبت میشود).
- مقایسهٔ دو نسخهٔ متوالی در همان صفحه در دسترس است.
۵. جستجو و سایدبار
- جستجوی متنی در عنوان و محتوای صفحات از خانهٔ wiki (حداقل ۲ کاراکتر).
- سایدبار درخت صفحات و لینک «بهروزرسانیهای اخیر» را نشان میدهد.
- عرض سایدبار قابل تغییر است (کشیدن جداکننده).
۶. پلن و محدودیتها
WikiRabbit در پلنهای بالاتر فعال است؛ تعداد صفحهٔ مجاز per مخزن به پلن مالک بستگی دارد (maxWikiPagesPerRepo؛ مقدار -1 یعنی نامحدود). جزئیات در صفحهٔ قیمتگذاری.
۷. مستندات مرتبط
- پروفایل و همکاری — نقشها و دسترسی commit
- گانت — زمانبندی پروژه در کنار مستندات
- CI/CD — اتوماسیون جدا از wiki