Preskočiť na obsah

Vlastné jazyky a témy

Zobraziť ako Markdown Upraviť na GitHub Dokumentácia na 22946a5

Pribalená sada pokrýva celý katalóg Shiki, ale môžete zaregistrovať aj vlastnú gramatiku TextMate alebo tému VS Code z dekódovaného JSON. Obe sa ukladajú v inštancii Highlighter.

Vlastné témy

Dekódujte súbor témy VS Code JSON a odovzdajte ho do loadTheme. Téma sa identifikuje podľa name a vlastná téma nahradí pribalenú tému s rovnakým názvom.

PHP
use Shikiphp\Shikiphp;

$highlighter = Shikiphp::highlighter();

$theme = json_decode(file_get_contents('my-theme.json'), true);
$highlighter->loadTheme($theme);

$code = '<?php echo "hello";';

echo $highlighter->codeToHtml($code, [
    'lang'  => 'php',
    'theme' => $theme['name'], // the theme's own name
]);

Vlastné gramatiky

loadGrammar zaregistruje dekódovanú gramatiku .tmLanguage.json, aby ju každý vstupný bod mohol použiť podľa ID jazyka:

PHP
public function loadGrammar(
    array $rawTmLanguage,
    ?string $langId = null,
    array $aliases = [],
    array $embedded = [],
): void
  • $langId — ID, pod ktorým sa na ňu odkazuje. Ak nie je zadané, použije sa name gramatiky a potom jej scopeName.
  • $aliases — ďalšie ID, ktoré odkazujú na tú istú gramatiku.
  • $embedded — ID jazykov vložených do tejto gramatiky; načítajú sa aj ich gramatiky.
PHP
use Shikiphp\Shikiphp;

$highlighter = Shikiphp::highlighter();

$grammar = json_decode(file_get_contents('mylang.tmLanguage.json'), true);
$highlighter->loadGrammar($grammar, 'mylang', aliases: ['ml']);

$code = file_get_contents('example.mylang');

echo $highlighter->codeToHtml($code, [
    'lang'  => 'mylang',
    'theme' => 'github-dark',
]);

Odkazy include na gramatiky (#repo, $self, $base, other.scope) a vložené jazyky sa priraďujú ku gramatikám, ktoré už sú zaregistrované v zvýrazňovači. Preto najprv zaregistrujte všetky závislosti.

Použitie vlastného zvýrazňovača cez fasádu

Ak chcete, aby statická fasáda Shikiphp používala váš upravený zvýrazňovač, odovzdajte jej ho pomocou Shikiphp::use:

PHP
use Shikiphp\Highlighter;
use Shikiphp\Shikiphp;

$myTheme = json_decode(file_get_contents('my-theme.json'), true);
$myGrammar = json_decode(file_get_contents('mylang.tmLanguage.json'), true);
$code = file_get_contents('example.mylang');

$highlighter = Highlighter::createBundled();
$highlighter->loadTheme($myTheme);
$highlighter->loadGrammar($myGrammar, 'mylang');

Shikiphp::use($highlighter);

// Now the facade delegates to your highlighter.
echo Shikiphp::codeToHtml($code, ['lang' => 'mylang', 'theme' => $myTheme['name']]);

Volaním Shikiphp::reset() sa vrátite k predvolenému zvýrazňovaču z balíka.