vscode ile README dosyalarının daha etkin kullanımı

[taydin]

Çoğu yazılım projesinin içerisine README isimli text dosyaları konulur ve bu dosyalarda da program ile ilgili önemli bilgiler yer alır. Eğer dosya içinde sadece metin var ise, o zaman vscode sorunsuz olarak bunu bir metin dosyası olarak algılar ve ona göre de görüntüler. Ama birçok durumda da README dosyasının içinde açıklayıcı kod parçaları da bulunur. Bu durumda da vscode, dosyayı inceleyip bazan bu kod parçalarına dayanarak dosyanın tamamının o kodu içeren kaynak kodu olduğuna karar verir ve yanlış renklendirme yapar, hata mesajları koyar.

Burada ideal olarak vscode'dan istediğimiz nedir? Açıklama paragrafını metin olarak algılasın ve renklendirsin, kod kısmını da bash script programı olarak algılasın ve ona göre renklendirsin.

Bunun için önce vscode genel yapılandırma dosyasını açıp, README isimli dosyaların "markdown" olarak algılanmasını sağlıyoruz

    "files.associations": {
    "README": "markdown"
    },

Sonra da README içerisinde program olan yerleri aşağıdaki gibi işaretliyoruz: üç tane "backtick", ondan sonra program türü (bash) sonra program içeriğini yazıyoruz. Program içeriğinin sonuna da gene üç tane backtick ekliyoruz. Bundan sonra yazılacak herşey artık tekrar metin olarak algılanacak.