@unifast/shiki

HAST dönüşümleriyle unifast için Shiki tabanlı sözdizimi vurgulama plugin'i

Genel Bakış

@unifast/shiki, Shiki tarafından desteklenen sözdizimi vurgulaması sağlar ve 200+ dili ile çok çeşitli temaları destekler. Dahili highlight plugin’inin aksine Shiki, JavaScript’te bir HAST dönüşümü olarak çalışır ve <pre><code> bloklarını zengin stillendirilmiş çıktıyla değiştirir.

Plugin, çift işlemeyi önlemek için dahili Rust vurgulayıcısını otomatik olarak devre dışı bırakır.

Kurulum

Tip Tanımları

ShikiTransformerOptions

ÖzellikTürVarsayılanAçıklama
themesBundledTheme[]["github-dark"]Yüklenecek Shiki temaları
defaultThemeBundledThemethemes‘deki ilk temaRender için varsayılan tema
langsBundledLanguage[][]Yüklenecek diller. Yalnızca yüklenen diller vurgulanır.

BundledTheme ve BundledLanguage, shiki paketindeki türlerdir.

ShikiTransformer

ÖzellikTürAçıklama
transform(hast: HastRoot) => HastRootTüm <pre><code class="language-*"> bloklarına Shiki vurgulamasını uygula

Export Özeti

ExportTürAçıklama
createShikiPluginfunctionBir Shiki UnifastPlugin oluştur (async)
createShikiTransformerfunctionBağımsız bir Shiki transformer oluştur (async)
ShikiTransformerOptionstypeShiki yapılandırma seçenekleri
ShikiTransformertypeTransformer arayüzü
hastToHtmlfunctionHAST’den HTML’e serileştirici (yeniden export edilmiş)
HastNode, HastRoot, vb.typesHAST düğüm türleri (yeniden export edilmiş)