Visual Studio Code için Yazma Paketini Öğrenme
Learn Yazma Paketi, Microsoft Learn içeriği için Markdown yazma işlemine yardımcı olan bir Visual Studio Code uzantıları koleksiyonudur. Paketi VS Code Marketi’nde mevcuttur ve şu uzantıları barındırır:
- Learn Markdown: Temel Markdown söz dizimi desteğinin yanı sıra uyarılar, kod parçacıkları ve yerelleştirilebilir olmayan metinler gibi özel Markdown söz dizimi desteği de dahil olmak üzere Microsoft Learn'de içerik için Markdown yazma yardımı sağlar. Artık içindekiler tablosu girişleri ekleme gibi temel YAML yazma desteği de sunmaktadır.
- markdownlint: Markdown'ınızın geçerli olduğundan emin olmak için David Anson tarafından kullanılan popüler bir Markdown linter.
- Code Spell Checker: Street Side Software tarafından oluşturulan tamamen çevrimdışı bir yazım denetimi aracı.
- Learn Preview: Özel Markdown da dahil olmak üzere daha doğru Markdown önizlemesi için Microsoft Learn CSS'yi kullanır.
- Makale Şablonlarını Öğrenin: Kullanıcıların Learn modüllerini iskelesine eklemesine ve markdown iskelet içeriğini yeni dosyalara uygulamasına olanak tanır.
- YAML'i öğrenin: YAML şema doğrulaması ve otomatik tamamlama sağlar.
- Görüntüleri Öğrenme: Microsoft Learn içeriğinin yazarlarına yardımcı olmak için klasörler ve tek tek dosyalar için görüntü sıkıştırma ve yeniden boyutlandırma sağlar.
Önkoşullar ve varsayımlar
Learn Markdown uzantısıyla göreli bağlantılar, görüntüler ve diğer ekli içerik eklemek için VS Code çalışma alanınızın kapsamı kopyalanmış Açık Yayımlama Sistemi (OPS) deponuzun köküne göre belirlenmiş olmalıdır. Örneğin, docs deposunu C:\git\SomeDocsRepo\
olarak kopyaladıysanız, vs Code: Dosya>Klasör Aç menüsünde veya komut satırından bu klasörü veya code C:\git\SomeDocsRepo\
alt klasörü açın.
Uzantı tarafından desteklenen uyarılar ve kod parçacıkları gibi bazı söz dizimi öğeleri, OPS için özel Markdown’dır. Özel Markdown, OPS yoluyla yayımlanmadığı sürece doğru işlenmez.
Learn Markdown uzantısını kullanma
Learn Markdown menüsüne erişmek için Alt+M yazın. İstediğiniz komutu seçmek için tıklayabilir veya yukarı ve aşağı okları kullanabilirsiniz. İsterseniz yazmaya başlayarak sonuçları filtreleyebilir ve istediğiniz işlev menüde vurgulandığında ENTER tuşuna basabilirsiniz.
Güncel komut listesi için Bkz. Learn Markdown benioku.
Ana yeniden yönlendirme dosyası oluşturma
Learn Markdown uzantısı, tek tek dosyalardaki meta verileri temel alarak bir depo için ana yeniden yönlendirme dosyası oluşturmaya veya güncelleştirmeye redirect_url
yönelik bir betik içerir. Bu betik, deposundaki redirect_url
her Markdown dosyasını denetler ve yeniden yönlendirme meta verilerini deponun ana yeniden yönlendirme dosyasına (.openpublishing.redirection.json) ekler ve yeniden yönlendirilen dosyaları depo dışındaki bir klasöre taşır. Betiği çalıştırmak için:
- VS Code komut paletini açmak için F1 tuşuna basın.
- "Learn: Generate..." yazmaya başlayın
Learn: Generate main redirection file
komutunu seçin.- Betiğin çalışması tamamlandığında, yeniden yönlendirme sonuçları VS Code çıkış bölmesinde gösterilir ve kaldırılan Markdown dosyaları varsayılan yolunuz altındaki Learn Authoring\redirects klasörüne eklenir.
- Sonuçları inceleyin. Beklediğiniz gibiyse depoyu güncelleştirmek için bir çekme isteği gönderin.
Klavye kısayolları atama
Klavye Kısayolları listesini açmak için Ctrl+K ve Ctrl+S yazın.
Özel tuş bağlaması oluşturmak istediğiniz komutu aratın, örneğin
formatBold
.Fare imlecinizle satırın üzerine geldiğinizde komutun yanında beliren artı işaretine tıklayın.
Giriş kutusu göründüğünde, bu komuta bağlamak istediğiniz klavye kısayolunu girin. Örneğin, kalın için ortak kısayolu kullanmak için Ctrl+B yazın.
Tuş bağlamanıza
when
yan tümcesini eklemek iyi bir fikir olabilir, böylece bu kısayol Markdown dışındaki dosyalarda geçerli olmayacaktır. Bunu yapmak için keybindings.json dosyasını açın ve komut adı altındaki şu satırı girin (satırlar arasına virgül koyduğunuzdan emin olun):"when": "editorTextFocus && editorLangId == 'markdown'"
Tamamlanmış özel tuş bağlamanız, keybindings.json dosyasında şu şekilde görünmelidir:
[ { "key": "ctrl+b", "command": "formatBold", "when": "editorTextFocus && editorLangId == 'markdown'" } ]
Bahşiş
Varsayılan değerlerin üzerine yazmak için tuş bağlamalarınızı bu dosyaya yerleştirin.
keybindings.json dosyasını kaydedin.
Tuş bağlamaları hakkında daha fazla bilgi için VS Code belgelerine bakın.
Eski “Gauntlet” araç çubuğunu gösterme
"Gauntlet" adlı uzantı kodunun eski kullanıcıları Learn Markdown Uzantısı yüklendiğinde yazma araç çubuğunun artık VS Code penceresinin altında görünmediğini fark eder. Bu araç çubuğu, VS Code durum çubuğunda geniş yer kapladığı ve uzantı UX’i için en iyi deneyimleri izlemediği için yeni uzantıda devre dışı bırakılmıştır. Ancak dilerseniz settings.json dosyasında VS Code ayarlarınızı aşağıdaki gibi güncelleştirerek bu araç çubuğunu tekrar gösterebilirsiniz:
VS Code'da Dosya>Tercihleri'ne> gidin Ayarlar veya Ctrl+ tuşunu seçin.
Ayarları tüm VS Code çalışma alanları için değiştirmek istiyorsanız Kullanıcı Ayarları’nı, yalnızca geçerli çalışma alanı için değiştirmek istiyorsanız Çalışma Alanı Ayarları’nı seçin.
Uzantılar>Learn Markdown Uzantısı Yapılandırması'nı seçin ve ardından alt durum çubuğunda Eski araç çubuğunu göster'i seçin.
Seçiminizi yaptıktan sonra VS Code, settings.json dosyasını güncelleştirir. Değişikliklerin etkili olması için pencereyi yeniden yüklemeniz istenir.
Uzantıya eklenen yeni komutlar araç çubuğundan kullanılamaz.
Learn şablonlarını kullanma
Learn Makale Şablonları uzantısı, VS Code'daki yazarların merkezi bir mağazadan Markdown şablonu çekmesine ve bunu bir dosyaya uygulamasına olanak tanır. Şablonlar makalelere gerekli meta verilerin eklenmesi ve içerik standartlarına uygun hareket edilmesi gibi konulardan emin olmanıza yardımcı olabilir. Şablonlar, genel bir GitHub deposunda Markdown dosyaları olarak yönetilir.
VS Code'da şablon uygulama
- Learn Makale Şablonları uzantısının yüklendiğinden ve etkinleştirildiğinden emin olun.
- Learn Markdown uzantısı yüklü değilse, komut paletini açmak için F1'e tıklayın, filtrelemek için "şablon" yazmaya başlayın ve ardından öğesine tıklayın
Learn: Template
. Learn Markdown yüklüyse komut paletini kullanabilir veya Alt+M'ye tıklayarak Learn Markdown QuickPick menüsünü açıp listeden seçim yapabilirsiniz.Template
- Açılan listeden istenen şablonu seçin.
GitHub kimliğinizi ve/veya Microsoft diğer adınızı VS Code ayarlarınıza ekleme
Templates uzantısı, üç dinamik meta veri alanını destekler: author, ms.author ve ms.date. Bu da şablon oluşturan bir kullanıcının bu alanları bir Markdown şablonunun meta veri başlığında kullanması durumunda bu değerlerin şablonu uyguladığınızda aşağıdaki şekilde dosyanıza otomatik olarak ekleneceği anlamına gelir:
Meta veri alanı | Değer |
---|---|
author |
VS Code ayar dosyasında belirtilen GitHub diğer adınız. |
ms.author |
VS Code ayar dosyasında belirtilen Microsoft diğer adınız. Microsoft çalışanı değilseniz bu alanı boş bırakın. |
ms.date |
Desteklenen biçimdeki geçerli tarih, MM/DD/YYYY . Dosyayı daha sonra güncelleştirirseniz tarih otomatik olarak güncelleştirilmez ve el ile güncelleştirmeniz gerekir. Bu alan "makalenin güncelliğini" belirtmek için kullanılır. |
author ve/veya ms.author değerlerini ayarlama
- VS Code'da Dosya>Tercihleri'ne> gidin Ayarlar veya Ctrl+ tuşunu seçin.
- Ayarları tüm VS Code çalışma alanları için değiştirmek istiyorsanız Kullanıcı ayarlarını, yalnızca geçerli çalışma alanı için değiştirmek istiyorsanız Çalışma Alanı ayarlarını seçin.
- Soldaki Varsayılan Ayarlar bölmesinde, Learn Makale Şablonları Uzantısı Yapılandırması'nı bulun, istediğiniz ayarın yanındaki kalem simgesine tıklayın ve ardından Ayarlar Değiştir'e tıklayın.
- Kullanıcı ayarları bölmesi yan tarafta açılır ve en altta yeni bir giriş gösterilir.
- GitHub kimliğinizi veya Microsoft e-posta diğer adınızı ekleyin ve dosyayı kaydedin.
- Değişikliklerin geçerli olması için VS Code uygulamasını kapatıp yeniden başlatmanız gerekebilir.
- Artık dinamik alanları kullanan bir şablon uyguladığınızda GitHub kimliğiniz ve/veya Microsoft takma adınız meta veri başlığına otomatik olarak eklenecek.
Yeni bir şablonu VS Code'da kullanılabilir duruma getirmek için
- Şablonunuzdan bir Markdown dosyası taslağı oluşturun.
- MicrosoftDocs/content-templates deposunun templates klasörüne bir çekme isteği gönderin.
İçerik ekibi şablonunuzu gözden geçirir ve stil yönergelerini karşılıyorsa çekme isteğini birleştirir. Birleştirildikten sonra şablon, Learn Makale Şablonları uzantısının tüm kullanıcılarına sunulacaktır.
Farklı özelliklerin tanıtımı
Learn Yazma Paketi'nin aşağıdaki özelliklerini gösteren kısa bir video aşağıdadır:
- YAML dosyaları
- "Learn: Depodaki dosya bağlantısı" desteği
- Markdown dosyaları
- "ms.date" Meta Veri Değeri bağlam menüsü seçeneğini güncelleştirme
- Kod çiti dil tanımlayıcıları için kod otomatik tamamlama desteği
- Tanınmayan kod çiti dil tanımlayıcısı uyarıları/otomatik düzeltme desteği
- Seçimi artan düzende sıralama (A - Z)
- Seçimi azalan düzende sıralama (Z - A)
Sonraki adımlar
Learn Authoring Pack, Visual Studio Code uzantısında bulunan çeşitli özellikleri keşfedin.