GitHub importi

Cirth markdown hujjatlarini to'g'ridan-to'g'ri GitHub repozitoriylaringizdan import qilishi mumkin, bu esa mavjud hujjatlarni ko'chirish yoki hujjatlarni kodingizga yaqin saqlashni osonlashtiradi.

Bu qanday ishlaydi

1. Ulanish - Repozitoriy tafsilotlarini taqdim eting

2. Ko'zdan kechirish - Qaysi fayllarni import qilishni tanlang

3. Import qilish - Cirth markdown-ni sahifalarga aylantiradi

Import jarayoni:

• Metadata uchun frontmatter-ni tahlil qiladi

• Sarlavhalarni H1 sarlavhalaridan ajratib oladi

• Markdown-ni boy HTML-ga aylantiradi

• SEO uchun qulay sluglar yaratadi

Importni boshlash

1. Loyiha boshqaruv paneli (Project Dashboard) ga o'ting

2. GitHub-dan import qilish (Import from GitHub) tugmasini bosing

3. Repozitoriy tafsilotlarini kiriting:

   • Repozitoriy: egasi/repo yoki to'liq URL

   • Shoxcha (Branch): Odatda main yoki master

   • Hujjatlar yo'li: Hujjatlar joylashgan papka (masalan, /docs)

Repozitoriy formati

Qo'llab-quvvatlanadigan fayl turlari

• .md - Standart markdown

• .mdx - JSX bilan markdown (standart markdown-ga aylantiriladi)

Tavsiya etilgan tuzilma

      

        plaintext
        
          
          
        
      
    sizning-repongiz/
├── docs/
│   ├── getting-started.md
│   ├── installation.md
│   ├── configuration.md
│   └── api/
│       ├── overview.md
│       ├── authentication.md
│       └── endpoints.md
└── README.md

Frontmatter qo'llab-quvvatlash

Import xatti-harakatlarini boshqarish uchun YAML frontmatter qo'shing:

      

        markdown
        
          
          
        
      
    ---
title: Ishni boshlash
description: Bizning SDK bilan qanday ishlashni o'rganing
order: 1
---

# Ishni boshlash

Sizning kontentingiz bu yerda...

Qo'llab-quvvatlanadigan frontmatter maydonlari

Importni ko'zdan kechirish (Preview)

Import qilishdan oldin Cirth ko'rinishni ko'rsatadi:

• Fayl yo'li - Repozitoriydagi asl joylashuvi

• Sarlavha - Ajratib olingan yoki frontmatter-dan olingan

• Slug - Yaratilgan URL yo'li

Siz quyidagilarni amalga oshira olasiz:

• Alohida fayllarni tanlash/bekor qilish

• Hammasini tanlash yoki birontasini tanlamaslik

• Importdan oldin sarlavhalarni ko'rib chiqish

Slug yaratish

Sluglar fayl yo'llaridan avtomatik ravishda yaratiladi:

Ziddiyatlarni hal qilish

Agar slug allaqachon mavjud bo'lsa:

• Mavjud sahifa kontenti almashtiriladi

• Sahifa sozlamalari saqlanib qoladi

• Tarix saqlanadi

Ziddiyatlardan qochish uchun:

• Noyob fayl nomlaridan foydalaning

• Importdan oldin mavjud sahifalarni tekshiring

Shaxsiy repozitoriylar (Private Repositories)

Shaxsiy repozitoriylardan import qilish uchun:

1. GitHub Personal Access Token yarating

2. Kerakli ruxsatlar: repo (shaxsiy repolar uchun)

3. Import paytida so'ralganda tokenni kiriting

Xavfsizlik eslatmasi: Tokenlar faqat import paytida ishlatiladi va saqlanmaydi.

Import tarixi

Importlaringizni kuzatib boring:

1. Loyiha sozlamalari > GitHub bo'limiga o'ting

2. Quyidagilar bilan import tarixini ko'ring:

   • Sana va vaqt

   • Repozitoriy va shoxcha

   • Import qilingan fayllar

   • Holat (muvaffaqiyatli/muvaffaqiyatsiz)

Qayta import qilish

Repozitoriy o'zgarishlari bilan sinxronlash uchun:

1. GitHub-dan import qilish tugmasini yana bosing

2. Oldingi sozlamalaringiz eslab qolinadi

3. Qayta import qilinadigan fayllarni tanlang

4. Mavjud sahifalar yangilanadi

Eng yaxshi amaliyotlar

Repozitoriyni tashkil qilish

      

        plaintext
        
          
          
        
      
    docs/
├── 01-getting-started/
│   ├── 01-introduction.md
│   ├── 02-installation.md
│   └── 03-quick-start.md
├── 02-guides/
│   ├── 01-basics.md
│   └── 02-advanced.md
└── 03-api-reference/
    └── 01-overview.md

Raqamlangan prefikslardan foydalanish tartibni saqlashga yordam beradi.

Frontmatter-dan foydalaning

Har doim quyidagilar uchun frontmatter kiriting:

• Barqaror sarlavhalar

• SEO tavsiflari

• Aniq tartiblash

README-ni alohida saqlang

Repozitoriydagi README.md ko'pincha hujjatlardan farq qiladi. Quyidagilarni o'ylab ko'ring:

• Uni importdan chiqarib tashlash

• Yoki maxsus docs/ papkasini yaratish

Muntazam sinxronlash

Qayta import qilish jadvalini belgilang:

• Asosiy relizlardan keyin

• Repoda hujjatlar yangilanganda

• Reliz jarayonining bir qismi sifatida

Muammolarni bartaraf etish

Fayllar ko'rinmayapti

• Hujjatlar yo'li to'g'ri ekanligini tekshiring

• Fayllar .md kengaytmasiga ega ekanligiga ishonch hosil qiling

• Shoxcha nomi mos kelishini tasdiqlang

Noto'g'ri sarlavhalar

• Frontmatter-ga title qo'shing

• H1 sarlavhasi eng tepada ekanligiga ishonch hosil qiling

• Maxsus belgilarni tekshiring

Import muvaffaqiyatsiz tugadi

• Repozitoriyga kirish imkoni borligini tekshiring

• Shoxcha mavjudligini tasdiqlang

• Shaxsiy repolar uchun token ruxsatlarini tekshiring