# Laravel package to use typst

[![Latest Version on Packagist](https://img.shields.io/packagist/v/scalexy/laravel-typst.svg?style=flat-square)](https://packagist.org/packages/scalexy/laravel-typst)
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/scalexy/laravel-typst/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/scalexy/laravel-typst/actions?query=workflow%3Arun-tests+branch%3Amain)
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/scalexy/laravel-typst/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/scalexy/laravel-typst/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[![Total Downloads](https://img.shields.io/packagist/dt/scalexy/laravel-typst.svg?style=flat-square)](https://packagist.org/packages/scalexy/laravel-typst)

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

## Support us

[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/laravel-typst.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/laravel-typst)

We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).

## Installation

You can install the package via composer:

```bash
composer require scalexy/laravel-typst
```

You can publish and run the migrations with:

```bash
php artisan vendor:publish --tag="laravel-typst-migrations"
php artisan migrate
```

You can publish the config file with:

```bash
php artisan vendor:publish --tag="laravel-typst-config"
```

This is the contents of the published config file:

```php
return [
];
```

Optionally, you can publish the views using

```bash
php artisan vendor:publish --tag="laravel-typst-views"
```

## Usage

```php
$laravelTypst = new ScaleXY\LaravelTypst();
echo $laravelTypst->echoPhrase('Hello, ScaleXY!');
```

## Testing

```bash
composer test
```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

- [<NAME>](https://github.com/Athuli7)
- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
