Download the PHP package torchlight/torchlight-jigsaw without Composer
On this page you can find all versions of the php package torchlight/torchlight-jigsaw. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download torchlight/torchlight-jigsaw
More information about torchlight/torchlight-jigsaw
Files in torchlight/torchlight-jigsaw
Package torchlight-jigsaw
Short Description A Torchlight client for the static site generator Jigsaw
License MIT
Homepage https://torchlight.dev
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package torchlight-jigsaw
Torchlight Client for Jigsaw
A Torchlight syntax highlighting extension for the static site builder Jigsaw.
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.
📚 The full docs can be found at torchlight.dev/docs/clients/jigsaw.
Installation
To install, require the package from composer:
After the package is downloaded, add the following line to your bootstrap.php
This will boot the extension so that it can register its bindings, events, and commands.
Now your bootstrap.php might look something like this:
Configuration
To configure your Torchlight integration, you can start by publishing the configuration file:
Once run, you should see a new file torchlight.php in the root of your project, with contents that look like this:
Theme
You can change the theme of all your code blocks by adjusting the theme key in your configuration.
Token
This is your API token from torchlight.dev. (Torchlight is completely free for personal and open source projects.)
Blade Components
By default Torchlight works with both Markdown files as well as Blade files, 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.
Host
You can change the host where your API requests are sent. Not sure why you'd ever want to do that, but you can!
Cache
Torchlight requires a separate cache path, distinct from the Jigsaw cache. Jigsaw cleans out its cache from time to time, whereas Torchlight depends on individual TTLs, courtesy of the Laravel cache driver.
You may want to add your configured cache path (
/torchlight_cache/) to your.gitignorefile so the cache files aren't persisted to your git history.
Usage
Markdown
To use Torchlight in your Jigsaw markdown files, you don't need to do anything else beside using fenced code blocks like you have been.
This is my great markdown file! I'm going to show some code now:
Wasn't that good code?Torchlight will handle highlighting that block of code.
If you want to add additional classes or an ID, you can use the syntax that is supported by Jigsaw's underlying markdown parser.
This is my great markdown file! I'm going to show some code now:
Wasn't that good code?The resulting code element will have an id of some-html-id and classes of mt-4 mb-8, along with any classes that Torchlight applies.
Blade
If you want to use Torchlight in your .blade.php files, you can use the custom blade component x-torchlight-code.
You can add any classes or other attributes, and they will be preserved:
