NuGet.org'da paket benioku

Paket ayrıntılarınızı kullanıcılarınız için daha zengin ve daha bilgilendirici hale getirmek için NuGet paketinize bir benioku dosyası ekleyin!

Bu, kullanıcıların paket ayrıntıları sayfanızı NuGet.org görüntülerken göreceği ilk öğelerden biridir ve iyi bir izlenim vermek için gereklidir!

Beniokum neleri içermelidir?

Beniokumanıza aşağıdaki öğeleri eklemeyi göz önünde bulundurun:

• Paketinizin ne olduğuna ve ne yaptığına giriş - hangi sorunları çözer?
• Paketinizi kullanmaya nasıl başlarsınız? Belirli gereksinimler var mı?
• Benioku'ya dahil edilmediği takdirde daha kapsamlı belgelere bağlantılar.
• En az birkaç kod parçacığı/örnek veya örnek görüntü.
• Proje sorunlarına bağlantı, Twitter, hata izleyicisi veya başka bir platform gibi geri bildirimlerin nerede ve nasıl bırakıldığı.
• Varsa nasıl katkıda bulunabileceğiniz.

Yüksek kaliteli beniokuların çok çeşitli biçimlerde, şekillerde ve boyutlarda gelebileceğini unutmayın! NuGet.org'da zaten kullanılabilir bir paketiniz varsa, deponuzda NuGet.org ayrıntıları sayfanıza harika bir ek olacak bir veya başka bir readme.md belge dosyanız olma olasılığı yüksektir.

Beniokunuzun önizlemesini görüntüleme

Benioku dosyanızın önizlemesini NuGet.org'da canlı olarak görüntülemek için, NuGet.org'da Paketi Karşıya Yükle web portalını kullanarak paketinizi karşıya yükleyin ve meta veri önizlemesinin "Benioku Dosyası" bölümüne gidin. Şuna benzer şekilde görünecektir:

Görüntü uyumluluğu ve desteklenen biçimlendirme için benioku dosyanızı gözden geçirmek ve önizlemek için zaman ayırarak olası kullanıcılara harika bir ilk izlenim verdiğinden emin olun! Paketiniz NuGet.org yayımlandıktan sonra benioku paketinizdeki hataları düzeltmek için, düzeltmeyi içeren güncelleştirilmiş bir paket sürümü göndermeniz gerekir. Her şeyin önceden iyi göründüğünden emin olmak, yoldaki baş ağrınızı kurtarabilir.

Görüntüler ve rozetler için izin verilen etki alanları

Güvenlik ve gizlilik endişeleri nedeniyle, NuGet.org görüntülerin ve rozetlerin işlenebileceği etki alanlarını güvenilen konaklara kısıtlar.

NuGet.org, aşağıdaki güvenilen etki alanlarındaki rozetler de dahil olmak üzere tüm görüntülerin işlenmesine izin verir:

• api.codacy.com
• app.codacy.com
• api.codeclimate.com
• api.dependabot.com
• api.travis-ci.com
• api.reuse.software
• app.fossa.com
• app.fossa.io
• avatars.githubusercontent.com
• badge.fury.io
• badgen.net
• badges.gitter.im
• buildstats.info
• caniuse.bitsofco.de
• camo.githubusercontent.com
• cdn.jsdelivr.net
• cdn.syncfusion.com
• ci.appveyor.com
• circleci.com
• codecov.io
• codefactor.io
• coveralls.io
• dev.azure.com
• flat.badgen.net
• github.com/.../workflows/.../badge.svg
• gitlab.com
• img.shields.io
• i.imgur.com
• isitmaintained.com
• opencollective.com
• raw.github.com
• raw.githubusercontent.com
• snyk.io
• sonarcloud.io
• travis-ci.com
• travis-ci.org
• wakatime.com
• user-images.githubusercontent.com

İzin verilenler listesine başka bir etki alanı eklenmesi gerektiğini düşünüyorsanız, lütfen bir sorun bildirin ve gizlilik ve güvenlik uyumluluğu için mühendislik ekibimiz tarafından gözden geçirilecektir. Göreli yerel yollara ve desteklenmeyen etki alanlarından barındırılan görüntüler işlenmez ve benioku dosyası önizlemesi ve paket ayrıntıları sayfasında yalnızca paket sahipleri tarafından görülebilen bir uyarı oluşturur.

Desteklenen Markdown özellikleri

Markdown, düz metin biçimli söz dizimine sahip hafif bir işaretleme dilidir. NuGet.org benioku, Markdig ayrıştırma altyapısı aracılığıyla CommonMark uyumlu Markdown'i destekler.

NuGet.org şu anda aşağıdaki Markdown özelliklerini desteklemektedir:

• Üst bilgiler
• Görüntüler
• Ek vurgu
• Listeler
• Bağlantılar
• Alıntıları engelle
• Ters eğik çizgi kaçışları
• Kod yayılımı
• Görev listeleri
• Tablolar
• Emojiler
• Otomatik bağlantılar

Söz dizimi vurgulama özelliğini de destekliyoruz. Kod aralıklarınızda söz dizimi vurgulama özelliğini etkinleştirmek için bir dil tanımlayıcısı ekleyebilirsiniz.