README

📚 完整文档可在 torchlight.dev/docs/clients/commonmark-php 找到。

为 Laravel 应用中的 PHP League 的 Commonmark Markdown 解析器 提供的 Torchlight 语法高亮扩展。

支持 CommonMark 1 和 2 版本。

Torchlight 是一个与 VS Code 兼容的语法高亮器，无需 JavaScript，支持所有语言，所有 VS Code 主题，行高亮，git diffing 等功能。

安装

要安装，从 composer 要求此包

composer require torchlight/torchlight-commonmark

这将安装 Laravel 客户端。

添加扩展

如果您使用 Graham Campbell 的 Laravel Markdown 包，您可以在 markdown.php 文件中“extensions”键下添加扩展。

'extensions' => [
    // Torchlight syntax highlighting
    TorchlightExtension::class,
],

如果您没有使用 Laravel Markdown 包，您可以手动添加扩展

// CommonMark V1
$environment = Environment::createCommonMarkEnvironment();
$environment->addExtension(new TorchlightExtension);

// CommonMark V2
$environment = new Environment();
$environment->addExtension(new CommonMarkCoreExtension);
$environment->addExtension(new TorchlightExtension);

这就完成了！您所有的代码块现在将通过 Torchlight 进行高亮。

配置

下载包后，您可以运行以下命令来发布您的配置文件

php artisan torchlight:install

运行后，您应该在 config 文件夹中看到一个名为 torchlight.php 的新文件，内容如下所示

<?php
return [
    // The Torchlight client caches highlighted code blocks. Here
    // you can define which cache driver you'd like to use.
    'cache' => env('TORCHLIGHT_CACHE_DRIVER'),

    // Which theme you want to use. You can find all of the themes at
    // https://torchlight.dev/themes, or you can provide your own.
    'theme' => env('TORCHLIGHT_THEME', 'material-theme-palenight'),

    // Your API token from torchlight.dev.
    'token' => env('TORCHLIGHT_TOKEN'),

    // If you want to register the blade directives, set this to true.
    'blade_components' => true,

    // The Host of the API.
    'host' => env('TORCHLIGHT_HOST', 'https://api.torchlight.dev'),
];

缓存

设置 Torchlight 将使用的缓存驱动器。

主题

您可以通过调整配置中的 theme 键来更改所有代码块的主题。

令牌

这是您从 torchlight.dev 获取的 API 令牌。（Torchlight 完全免费用于个人和开源项目。）

Blade 组件

默认情况下，Torchlight 通过使用一个 自定义 Laravel 组件 来工作。如果您出于任何原因想要禁用组件的注册，可以将此设置为 false。

主机

您可以更改发送 API 请求的主机。不确定您为什么要这样做，但您可以做到这一点！