dev

Highlight-js, bileşen tabanlı bir sözdizimi vurgulama kitaplığı olan Highlightjs'nin eşzamansız bir Fandom bağlantı noktasıdır. Orijinal belgeler readthedocs.io adresindedir.

Installation

Betiği içe aktarma

Highlight-js'yi kullanmak için, onu betiğinize içe aktarmanız gerekir. mw.hook kullanarak dev.highlight olayını dinleyebilirsiniz. 

// sınıf koşullarından kaçınmak için kancayı içe aktarmadan önce kaydedin
mw.hook('dev.highlight').add(function(hljs) {
    // hljs, window.dev.highlight için bir kısayoldur
});
importArticle({ type: 'script', article: 'u:dev:MediaWiki:Highlight-js.js' });

Betik bir window.dev.highlight (kanca içinde dahili takma ad hljs) oluşturur.

Dilleri yükleme

Kitaplık nesnesi, dilleri yüklemek için aşağıdaki yöntemlere sahiptir:

hljs.loadLanguages • hljs.loadLanguage (işlev)
Dil adı/diğer ad(lar) dizesini/dizisini kabul eder.
Dil bileşenlerini yükler ve kullanılacak Ertelenmiş bir olay döndürür.
Çözümlendiğinde bağımsız değişken olarak window.dev.highlight değerini iletir.
hljs.loadAllLanguages
Kitaplıktaki tüm dil bileşenlerini yükler.
Bağımsız değişken olarak hljs ile çözülen bir Ertelenmiş olay döndürür.
hljs.listLanguages (işlev)
Yüklenmiş bir dizi dil bileşeni adı döndürür.
hljs.registerLanguage (işlev)
Yeni dil bileşenlerini kaydetmek/yapılandırmak için kullanılan dahili yöntem.
hljs.loadedLanguage (işlev)
Dil adını/diğer adı belirten bir dizeyi kabul eder.
Yapılandırmasının yüklenip yüklenmediğini gösteren bir boole döndürür.

Kütüphane verileri ve doğrulama

Kitaplık doğrulaması ve veri alımı için aşağıdaki nesne yöntemleri/üyeleri kullanılır:

hljs.registry (nesne)
Kitaplık doğrulaması için diller, takma adlar ve stiller kaydı.
Aşağıdaki anahtarları içerir:
  • languages - kütüphanede bulunan dil kodları
  • aliases - dil takma adları için yeniden adlandırılmamış nesnesi
  • styles - başlıklara nesne eşleme stili adları
hljs.canonicalName (işlev)
Bir dil adı/takma adı için bir dize kabul eder.
Geçerliyse kurallı dil adını veya undefined döndürür.
hljs.getLanguage (işlev)
Dil adını/diğer adı belirten bir dizeyi kabul eder.
Dil bileşeni yapılandırması için nesneyi döndürür.
hljs.validLanguage (işlev)
Dil adını/diğer adı belirten bir dizeyi kabul eder.
Geçerli olup olmadığını gösteren bir boole döndürür.

Vurgulama işlevleri

Dil bileşenleri yüklendiğinde vurgulamak için aşağıdaki yöntemler kullanılır.

hljs.highlight (işlev)
Ana işlev - vurgulanacak bir dil adı ve dize değeri kabul eder.
Bağımsız değişkenler: (name, value, ?ignore_illegals, ?continuation)
Aşağıdaki anahtarlarla bir nesne oluşturur.
  • value - vurgulanmış metin
  • language - dil adı, yeniden adlandırılmamış
  • relevance - vurgulanan kimliklerin sayısı
You need to have hljs.loadLanguage(name) first!
hljs.highlightBlock (işlev)
DOM ögeleri için ana işlev - bir DOM düğümünü kabul eder.
Bağımsız değişkenler: (block) - kodun bloğu
Bir sınıf adı veya nohighlight olarak dil adını bekler.
Bloğu vurgular ve blok değişkenine bazı nesne anahtarları ekler.
Önce dili yüklemeniz gerekiyor!
hljs.highlightAuto (işlev)
En yüksek alaka düzeyine sahip dili hesaplar.
Metni ve isteğe bağlı bir dil alt kümesini kabul eder.
Bağımsız değişkenler: (block)
O dil için hljs.highlight nesnesini döndürür.
Önce tüm dilleri yüklemeniz gerekiyor!
hljs.initHighlightingOnLoad (işlev)
Madde içeriğindeki tüm düz kod bloklarını otomatik olarak vurgular.
Ayrıca yeni maddeler veya içerik yüklendiğinde kodu vurgular.
Not: Bu yöntem hljs.highlightAuto kullanmaz.
hljs.initHighlighting (işlev)
Madde içeriğindeki tüm düz kod bloklarını bir kez vurgular.
Bağımsız değişkenler: ($content) - JQuery olarak içerik (genellikle mw.util.$content)
hljs.useTheme (işlev)
Bir stil adını kabul eder ve o anda kullanılan stil olarak ayarlar.

Dil desteği

Aşağıdaki diller desteklenir:

Temalar

Aşağıdaki temalar desteklenir: