spatie / filament-markdown-editor
A markdown editor for Filament with code highlighting and image uploads
Installs: 25 744
Dependents: 2
Suggesters: 0
Security: 0
Stars: 134
Watchers: 4
Forks: 16
Language:JavaScript
Requires
- php: ^8.1
- filament/filament: ^3.0
- illuminate/contracts: ^9.0|^10.0|^11.0
- spatie/laravel-package-tools: ^1.13.6
Requires (Dev)
- laravel/pint: ^1.2
- nunomaduro/collision: ^6.3.1|^8.0
- orchestra/testbench: ^7.10.1|^8.0|^9.0
- pestphp/pest: ^1.22.1|^2.34
- pestphp/pest-plugin-laravel: ^1.3|^2.3
- phpunit/phpunit: ^9.5.25|^10.5
README
This package contains a Markdown editor form field to be used in Filament. The editor supports image uploads and will automatically highlight code snippets.
The Markdown field is powered by EasyMDE.
Support us
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
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. We publish all received postcards on our virtual postcard wall.
Installation
You can install the package via composer:
composer require spatie/filament-markdown-editor
Usage
In the form
function of your Filament resource, you can use make use of the Spatie\FilamentMarkdownEditor\MarkdownEditor
just like any other form element.
Optionally, you can tack on the standard Filament methods fileAttachmentsDisk
, fileAttachmentsVisibility
, ... to configure the image uploads.
use Spatie\FilamentMarkdownEditor\MarkdownEditor; public static function form(Form $form): Form { return $form ->schema([ // other fields ... MarkdownEditor::make('text') ->fileAttachmentsDisk('admin-uploads') ->fileAttachmentsVisibility('public') ->required(), ]); }
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.