Mukautetut kielet ja teemat

Näytä Markdown-muodossa Muokkaa palvelussa GitHub Dokumentaatio: 22946a5

Mukana toimitettu kielivalikoima kattaa koko Shiki-luettelon, mutta voit rekisteröidä omia TextMate-kielioppeja tai VS Code-teemoja puretuista JSON-tiedoista. Molemmat tallennetaan Highlighter-instanssiin.

Mukautetut teemat

Pura VS Code-teeman JSON-tiedosto ja anna se kohteelle loadTheme. Teema tunnistetaan sen arvolla name, ja mukautettu teema korvaa samannimisen mukana toimitetun teeman.

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
]);

Mukautetut kieliopit

loadGrammar rekisteröi puretun .tmLanguage.json-tiedoston, jotta kaikki käynnistyskohdat voivat käyttää sitä kielen tunnuksella:

PHP

public function loadGrammar(
    array $rawTmLanguage,
    ?string $langId = null,
    array $aliases = [],
    array $embedded = [],
): void

$langId — tunnus, jolla siihen viitataan. Jos sitä ei anneta, käytetään kieliopin arvoa name ja sen jälkeen arvoa scopeName.
$aliases — lisätunnukset, jotka viittaavat samaan kielioppiin.
$embedded — tämän kieliopin upottamat kielen tunnukset, joiden kieliopit myös selvitetään.

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',
]);

Kieliopin include-viittaukset (#repo, $self, $base, other.scope) ja upotetut kielet selvitetään korostimessa jo rekisteröityjen kielioppien perusteella. Rekisteröi siis ensin kaikki riippuvuudet.

Mukautetun korostimen käyttäminen julkisivun kautta

Jos haluat staattisen Shikiphp-julkisivun käyttävän mukautettua korostinta, anna se sille komennolla 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']]);

Palauta oletusarvoisesti mukana toimitettu korostin kutsumalla komentoa Shikiphp::reset().