From 78b28a1945e2b8f9eb3ddfc59e3526329e0728b1 Mon Sep 17 00:00:00 2001 From: Aaron Francis Date: Wed, 26 May 2021 19:03:18 -0500 Subject: [PATCH] Readme [ci skip] --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index 826efd3..d995ad7 100644 --- a/README.md +++ b/README.md @@ -102,3 +102,31 @@ You can change the host where your API requests are sent. Not sure why you'd eve 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. + +## Usage + +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. + +```markdown +This is my great markdown file! I'm going to show some code now: + +```php +echo "here is my code" +``` + +Wasn't that good code? +``` + +Torchlight will handle highlighting that block of code now. If you want to add additional classes or an ID, you can use the syntax that is supported by Jigsaw's [underlying markdown parser](https://github.com/michelf/php-markdown). + +```markdown +This is my great markdown file! I'm going to show some code now: + +```php {#some-html-id.mt-4.mb-8} +echo "here is my code" +``` + +Wasn't that good code? +``` + +The resulting code block will have an id of `some-html-id` and classes of `mt-4 mb-8`, along with any classes that Torchlight applies.