VS Code için Yeni bir Belgeler Yazma Paketi Sürümü

  • Makale

Bu gönderi, docs.microsoft.com ekibinde Kıdemli Program Yöneticisi Megan Bradley tarafından yazılmıştır.

Nisan ayında, DocFX tabanlı düzenlemeleri önizlemeye yönelik bir uzantı olan Docs Markdown uzantısını ve markdownlint'i içeren VS Code için Docs Yazma Paketi'nin ilk sürümünü duyurduk. Bugün, aşağıdaki yeni uzantıları içeren Docs Yazma Paketi'nin ikinci önemli sürümünü duyurmaktan mutluluk duyuyoruz:

  • Kod Yazım Denetleyicisi. Popüler talep üzerine, bu çevrimdışı yazım denetleyicisini Street Side Software tarafından paketledik, böylece katkıda bulunanlar çevrimiçi bir hizmet aracılığıyla bunu yapmak zorunda kalmadan kod örnekleri de dahil olmak üzere tüm içeriklerini yazım denetimi yapabilir.
  • Docs Makale Şablonları. Bu uzantı, içeriği ve meta verileri tutarlı bir şekilde oluşturmayı kolaylaştırarak yeni bir dosyaya Markdown şablonu uygulamanızı sağlar.
  • Docs Preview. Docs Yazma Paketi'nin ilk sürümünde yer alan DocFx önizlemesinin yerini alır. Yeni önizleme uzantısı çok daha sağlamdır ve CSS'nin daha yüksek kalitede docs.microsoft.com temsil eder.

Uzantıları yukarıdaki bağlantılar aracılığıyla veya Docs Yazma Paketi aracılığıyla tek bir pakette tek tek yükleyebilirsiniz.

Makale Şablonlarına Giriş

Makale şablonları standart başlıklar, dosya meta verileri, ortak metin ve docs.microsoft.com yönergelerini izleyen diğer temel öğeleri sağlayan, yeni makalelere katkıda bulunmayı kolaylaştıran ve yayımlama gereksinimlerinden kaynaklanan tahmin çalışmalarını ortadan kaldıran çatı Markdown dosyalarıdır!

Çıkan şablonu temel alan yeni bir dosya oluşturmak için Alt+M tuşuna basıp Şablon'u seçmeniz yeterlidir:

şablon uygulama

Daha İyi Önizleme

Eski DocFX tabanlı önizleme altyapısı, aşağıdaki iyileştirmeleri içeren yepyeni Docs Preview ile değiştirildi:

  • DocFx özellikli Markdown (DFM) yerine CommonMark uyumlu Markdig ayrıştırıcısı desteği.
  • CSS docs.microsoft.com güncel, daha yüksek kalitede özel Markdown öğelerini işleme.
  • Önizlemelerin daha hızlı ve gecikmesiz işlenmesini sağlayarak güvenilirlik geliştirildi.
  • Docs'a özgü Markdown uzantılarının kullanılabilir hale geldikçe sürekli büyüyen listesi için destek.

Katkıda Bulunun

Docs Markdown uzantıları açık kaynaktır; katkıları memnuniyetle karşılıyoruz!

Çoğu katkının, yazılımımızda ve içeriğimizde katkınızı kullanma haklarını bize verme hakkına sahip olduğunuzu belirten bir Katkıda Bulunan Lisans Sözleşmesi'ni (CLA) kabul etmenizi gerektirdiğini unutmayın. Ayrıntılar için bkz. https://cla.microsoft.com. Bir çekme isteği gönderdiğinizde, CLA robotu bir CLA sağlamanız gerekip gerekmediğini otomatik olarak belirler ve çekme isteğini uygun şekilde donatır (örn. etiket, açıklama). Robot tarafından sağlanan yönergeleri izlemeniz yeterlidir. Bunu Microsoft'a ait tüm depolarda yalnızca bir kez yapmanız gerekir.

Geri Bildirim

Uzantıları nasıl daha iyi hale getirebileceğimiz hakkında düşünceleriniz mi var? Yeni bir sorun açın!

En son gelişmeler için Twitter hesabımızı takip etmeyi unutmayın.

Dünyayı geliştiriciler için daha iyi bir yer haline getirmek mi istiyorsunuz? Ekibimize katılın!