GitHub README'leri ve Issue'ları Markdown Olarak Kaydetme

GitHub, açık kaynağın evi — paha biçilmez dokümantasyon, issue tartışmaları ve kod örnekleriyle dolu. GitHub zaten Markdown kullanmasına rağmen, kendi notlarınız veya dokümantasyonunuz için içerik çıkarmak her zaman kolay değil. İşte Save’in bunu kolaylaştırma yöntemi.

Neden GitHub İçeriğini Markdown Olarak Kaydetmeli?

GitHub içeriği zaten Markdown’da olsa da şunları yapmak isteyebilirsiniz:

• Çevrimdışı dokümantasyon oluşturma — referans için
• Proje wiki’leri oluşturma — birden fazla kaynaktan
• Önemli issue’ları arşivleme — kapatılmadan önce
• Araştırma derleme — birden fazla repository’den
• Dokümantasyonu AI asistanlarına besleme

Save GitHub’dan Ne Yakalar

README Dosyaları

• Biçimlendirmeyle tam README içeriği
• Syntax highlighting korunmuş kod blokları
• Tablolar ve listeler bozulmamış
• Görsel referanslar korunmuş

Issue’lar ve Tartışmalar

• Issue başlığı ve açıklaması
• Thread’deki tüm yorumlar
• Kod parçacıkları ve log’lar
• Referans bağlantılar

Pull Request’ler

• PR açıklaması ve değişiklikler
• İnceleme yorumları
• Bağlantılı issue’lar

Örnek Çıktı

# Proje Adı

![Build Status](badge-url)

## Kurulum

\`\`\`bash
npm install project-name
\`\`\`

## Kullanım

\`\`\`javascript
const project = require('project-name');
project.doSomething();
\`\`\`

## Yapılandırma

| Seçenek | Varsayılan | Açıklama |
|---------|------------|----------|
| debug | false | Debug modunu etkinleştir |
| timeout | 5000 | ms cinsinden istek zaman aşımı |

Kullanım Senaryoları

Kişisel Dokümantasyon Oluşturma

• Birden fazla repo’dan kurulum kılavuzları derleyin
• Hızlı referans sayfaları oluşturun
• Issue’lardan sorun giderme kılavuzları oluşturun

Proje Araştırması

• Farklı projelerin benzer sorunları nasıl çözdüğünü karşılaştırın
• Repository’ler genelinde kod kalıplarını analiz edin
• Ekibiniz için kütüphaneleri belgeleyin

Issue Takibi

• Gelecekteki referans için çözülmüş issue’ları arşivleyin
• Tam bağlamla hata raporlarını kaydedin
• Geçici çözümleri ve çözümleri belgeleyin

AI Geliştirme Yardımı

GitHub içeriğini AI asistanlarına besleyin:

• Karmaşık dokümantasyonu açıklasın
• Örneklere dayalı uygulamalar önersin
• Benzer sorunlara dayalı issue’larda hata ayıklasın

En İyi Sonuçlar için İpuçları

1. Her GitHub sayfasında çalışır — repo’lar, issue’lar, PR’lar, tartışmalar
2. Kod bloklarını yakalar — uygun sözdizimi biçimlendirmesiyle
3. Tabloları korur — dokümantasyonda yaygın

GitHub vs. Ham Markdown

GitHub’dan ham Markdown kopyalayabilseniz de Save:

• Render edilmiş içeriği dahil eder (oluşturulan docs için kullanışlı)
• Tam issue thread’lerini yakalar
• Wiki sayfalarında da çalışır
• GitHub’a özgü biçimlendirmeyi yönetir

Başlangıç

Chrome Web Store’dan Save’i yükleyin — geliştirme iş akışınızı geliştirin.

---

Sorularınız mı var? [email protected] adresinden bize ulaşın