JacobFitzp/nova-canvas

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# Nova Canvas

<img src="./images/header.png">

![Packagist Version](https://img.shields.io/packagist/v/jacobfitzp/nova-canvas)
![Packagist Downloads](https://img.shields.io/packagist/dt/jacobfitzp/nova-canvas)
![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/jacobfitzp/nova-canvas/phpcsfixer.yml?branch=main&label=code%20style&style=flat-square)
<a href="https://codeclimate.com/github/JacobFitzp/nova-canvas/maintainability"><img src="https://api.codeclimate.com/v1/badges/1833c95fad33395eda42/maintainability" /></a>

The ultimate WYSIWYG content editor for Laravel Nova. Custom-built on-top of TipTap, Canvas is designed to feel like a 
first-party package.

## Prerequisites

- Laravel >= 11
- PHP >= 8.3
- Laravel Nova >= 4

## Installation

You can install the package via composer:

```shell
composer require jacobfitzp/nova-canvas
```

## Usage

```php
Canvas::make('Content')
```

[Read full documentation here](https://jacobfitzp.github.io/nova-canvas-docs/about.html)

## Contribution

### Bugs

Feel free to open PR's to address bugs, or to perform general maintenance. 
But ensure it gets linked to an existing or new issue that clearly explains the **what** and **why**.

### Features

If you have an idea for a feature or improvement please open an "Ideas" discussion first.

Make sure to link this discussion to any PR's that you open.

### Documentation

See the [documentation repository](https://github.com/JacobFitzp/nova-canvas-docs).

## License

The MIT License (MIT). Please see License File for more information.