Tezkor ishga tushirish yo'riqnomasi
Hujjatlashtirish saytingizni 5 daqiqadan kamroq vaqt ichida ishga tushiring.
Ushbu qo'llanma sizga Cirth yordamida bir necha daqiqa ichida birinchi hujjatlashtirish saytingizni yaratishga yordam beradi.
Zaruriy shartlar
Cirth hisobi (cirth.uz saytida ro'yxatdan o'ting)
Hujjatlashtirish kontenti (yoki noldan boshlang!)
1-qadam: Loyiha yarating
Tizimga kirgandan so'ng, boshqaruv panelidan Yangi loyiha (New Project) tugmasini bosing
Loyiha tafsilotlarini to'ldiring:
Nomi: Loyihangizning ko'rinadigan nomi (masalan, "Mening API hujjatlarim")
Slug: URL uchun qulay identifikator (masalan, "mening-api-hujjatlarim")
Tavsif: Hujjatlar nimalarni qamrab olishi haqida qisqacha ma'lumot
Ko'rinishni sozlang:
Hujjatlarni hamma uchun ochiq qilish uchun Ommaviy (Public) tugmasini yoqing
Qidiruv tizimlari hujjatlaringizni topishini istasangiz, Qidiruvni indekslash (Search Indexing) funksiyasini yoqing
Loyihani yaratish tugmasini bosing
2-qadam: Birinchi sahifangizni yarating
Loyiha boshqaruv panelidan Yangi sahifa (New Page) tugmasini bosing
Sarlavhani kiriting (bu sizning sahifa sarlavhangizga aylanadi)
Boy matn tahrirlovchisi yordamida kontentingizni yozing:
Tezkor formatlash uchun markdown qisqartmalaridan foydalaning
Sintaksis yoritilgan kod bloklarini qo'shing
Havolalar, rasmlar va boshqalarni joylashtiring
Sahifa holatini Chop etilgan (Published) qilib sozlang
Saqlash tugmasini bosing
3-qadam: Hujjatlaringizni tashkil qiling
Cirth ierarxik sahifa tashkil qilishni qo'llab-quvvatlaydi:
plaintext
Ishni boshlash (ota sahifa)
├── O'rnatish (bola sahifa)
├── Konfiguratsiya (bola sahifa)
└── Birinchi qadamlar (bola sahifa)
API ma'lumotnomasi (ota sahifa)
├── Autentifikatsiya
└── EndpointlarBola sahifalarni yaratish uchun:
Yangi sahifa yaratishda Ota sahifa (Parent Page) ni tanlang
Sahifalar ketma-ketligini boshqarish uchun Tartib (Order) maydonidan foydalaning
Sahifalarni qayta tartiblash uchun ularni sudrab olib boring (drag and drop)
4-qadam: Saytingizni ko'zdan kechiring
Loyiha boshqaruv panelidan Hujjatlarni ko'rish (View Documentation) tugmasini bosing
Hujjatlaringiz endi quyidagi manzilda ishlamoqda:
cirth.app/docs/sizning-slugingizHavolani jamoangiz yoki foydalanuvchilar bilan baham ko'ring!
Muvaffaqiyat uchun maslahatlar
Reja bilan boshlang - Yozishdan oldin hujjatlashtirish tuzilmangizni rejalashtiring
Aniq sarlavhalardan foydalaning - O'quvchilarga tavsiflovchi sarlavhalar bilan harakatlanishda yordam bering
Kod misollarini kiriting - Dasturchilar amaliy misollarni yaxshi ko'radilar
Uni yangilab turing - Kontentni ko'rib chiqish va yangilash jadvalini belgilang