Skip to content

Commit

Permalink
Readme [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
aarondfrancis committed May 27, 2021
1 parent 78b28a1 commit 7152c2d
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,28 +105,32 @@ Torchlight requires a separate cache path, distinct from the Jigsaw cache. Jigsa

## 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.

```markdown
~~~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
~~~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.

### Blade

0 comments on commit 7152c2d

Please sign in to comment.