Package Data | |
---|---|
Maintainer Username: | aarondfrancis |
Maintainer Contact: | aaron@hammerstone.dev (Aaron Francis) |
Package Create Date: | 2021-03-13 |
Package Last Update: | 2024-05-16 |
Home Page: | https://torchlight.dev |
Language: | PHP |
License: | MIT |
Last Refreshed: | 2024-11-24 15:08:15 |
Package Statistics | |
---|---|
Total Downloads: | 218,895 |
Monthly Downloads: | 5,823 |
Daily Downloads: | 107 |
Total Stars: | 114 |
Total Watchers: | 2 |
Total Forks: | 16 |
Total Open Issues: | 14 |
A Torchlight syntax highlighting extension for the Laravel framework.
Torchlight is a VS Code-compatible syntax highlighter that requires no JavaScript, supports every language, every VS Code theme, line highlighting, git diffing, and more.
To install, require the package from composer:
composer require torchlight/torchlight-laravel
Once the package is downloaded, you can run the following command to publish your configuration file:
php artisan torchlight:install
Once run, you should see a new file torchlight.php
in you config
folder, with contents that look like this:
<?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'),
];
Set the cache driver that Torchlight will use.
You can change the theme of all your code blocks by adjusting the theme
key in your configuration.
This is your API token from torchlight.dev. (Torchlight is completely free for personal and open source projects.)
By default Torchlight works by using a custom Laravel component. If you'd like to disable the registration of the component for whatever reason, you can turn this to false.
You can change the host where your API requests are sent. Not sure why you'd ever want to do that, but you can!