Markdown Dene

Hızlı Başvuru

Markdown Hızlı Başvuru Kılavuzu Nedir?

Markdown hızlı başvuru kılavuzu, belgeler, README dosyaları, notlar ve web içeriği yazarken başvurabileceğiniz kısa bir sözdizimi rehberidir. Her kuralı ezberlemek yerine başlıklar, listeler, bağlantılar, tablolar ve kod blokları için hazır kalıpları kopyalayabilirsiniz.

Bu sayfa hız için tasarlanmıştır: örnekler kopyalamaya hazır olup CommonMark kurallarına ve orijinal Markdown projesine dayanmaktadır. Markdown Biçimlendirici ve Markdown Düzenleyici ile birlikte kullanıldığında çok işe yarar.

Belgeleme portallarında veya depolarda yayın yapıyorsanız sözdizimi uyumluluğu önemlidir. Bu hızlı başvuru, GitHub belgelerinde ve CommonMark uyumlu düzenleyicilerde yaygın olarak kullanılan kalıpları içerir.

Her şey tarayıcınızda çalışır. Yazarken ve sözdizimini kontrol ederken içeriğiniz cihazınızda kalır.

Markdown Hızlı Başvuru Kılavuzu Nasıl Kullanılır?

Markdown sözdizimini başvurmak ve denemek için bu adımları izleyin. Her adım bu sayfadaki gerçek panelleri kullanır.

1

Yapıştırın, Yükleyin veya Örnek Yükleyin

Sol Markdown Dene paneline Markdown yazın veya yapıştırın, ya da bir dosya yüklemek için Yükleye tıklayın. API belgeleri örneği görmek için Örneke tıklayın. Sağ Hızlı Başvuru paneli temel sözdizimini, kodu, tabloları ve görev listelerini gösterir.

2

Başvurun ve Pratik Yapın

Başlıklar, vurgu, bağlantılar, kod blokları ve tablolar için hızlı başvuruyu kullanın. Denemek için kalıpları sol panele kopyalayın. CommonMark ve GitHub ile uyumludur.

3

Kopyalayın veya İndirin

Hızlı başvuruyu kaydetmek için Kopyala veya İndire tıklayın. Sıfırdan başlamak için Temizleyi kullanın. Tüm işlemler tarayıcınızda çalışır.

Güvenilir Markdown Kaynakları

Geliştiriciler, teknik yazarlar ve belgeleme ekipleri tarafından kullanılan yetkili kaynaklar:

Bu Kaynaklar Nasıl Kullanılır?

CommonMark'ı temel alın, GitHub/GitLab belgelerinden platforma özgü davranışları kontrol edin ve yayınlamadan önce render edilmiş çıktıyı doğrulayın.

Yaygın Kullanım Senaryoları

README Yazımı

Depolarda proje belgeleri yazarken hızlı sözdizimi örneklerinden yararlanın.

Teknik Notlar

Tasarım belgeleri, olay notları ve mimari güncellemeleri tutarlı biçimlendirmeyle yazın.

Ekip Oryantasyonu

Yeni ekip üyeleri her kuralı sıfırdan öğrenmek yerine çalışan sözdizimini kopyalayabilir.

Kontrol Listeleri

Dağıtım, QA ve sürüm görev listelerini doğru Markdown kontrol listesi biçimlendirmesiyle oluşturun.

Sık Sorulan Sorular

Bu standart Markdown'a mı dayanıyor?

Evet. Başvuru kılavuzu yaygın kullanılan CommonMark uyumlu sözdizimini izler. Resmi kurallar için CommonMark spesifikasyonuna bakın.

Hızlı başvurunun tamamını kopyalayabilir miyim?

Evet. Tam başvuruyu anında panonuza kopyalamak için kopyalama düğmesini kullanın.

Dosya olarak indirebilir miyim?

Evet. Hızlı başvuruyu .md dosyası olarak kaydetmek için indirme düğmesini kullanın.

Metnim tarayıcıyı terk eder mi?

Hayır. Diğer Markdown araçlarında olduğu gibi her şey tarayıcınızda yerel olarak çalışır.

Burada Markdown'ı HTML'ye dönüştürebilir miyim?

Evet. Dönüştürmeye ihtiyacınız olduğunda Markdown'dan HTML'ye aracını kullanın. HTML semantiği için MDN HTML belgelerine bakın.

Dağınık Markdown'ı temizleyebilir miyim?

Evet. Boşluk ve yapıyı düzeltmek için Markdown Biçimlendiriciyi kullanın.

Diğer Markdown Araçları

Yazma, biçimlendirme ve dönüştürme iş akışlarında hızlı başvuruyla birlikte kullanın: