assertchris / better-markdown-editor
A better markdown editor than the one that ships with Filament
Installs: 8
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Language:CSS
Requires
- php: ^8.1
- filament/filament: ^3.2
- filament/forms: ^3.2
- spatie/laravel-package-tools: ^1.15
Requires (Dev)
- larastan/larastan: ^2.0
- laravel/pint: ^1.0
- nunomaduro/collision: ^7.9|^8.0
- orchestra/testbench: ^8.0|^9.0
- pestphp/pest: ^2.1
- pestphp/pest-plugin-arch: ^2.0
- pestphp/pest-plugin-laravel: ^2.0
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-phpunit: ^1.0
- spatie/laravel-ray: ^1.26
README
A better markdown editor than the one that ships with Filament.
Installation
You can install the package via composer:
composer require assertchris/better-markdown-editor
You can publish the config file with:
php artisan vendor:publish --tag="better-markdown-editor-config"
Optionally, you can publish the views using
php artisan vendor:publish --tag="better-markdown-editor-views"
This is the contents of the published config file:
return [
];
Usage
use AC\BetterMarkdownEditor\BetterMarkdownEditor; BetterMarkdownEditor::make('markdown') // ...all the methods from the current MarkdownEditor // with the addition of some new methods ->hasLanguageAssistance(),
Motivation
Why build this?
I wanted to build a writing platform. I love Filament, but none of the fields had the functionality I use other apps for. It started as me wanting to make Filament's MarkdownEditor able to point out needlessly complex sentences and poor wording.
Why not contribute those improvements to Filament?
I tried, but they're understandably hesitant to take on the maintenance burden.
Why is it better?
For a start, it does what Hemingway does; but better.
Here's what I am planning to add in the near future (while procrastinating writing projects):
- fullscreen mode
- opt-in LLM-based error correction (with loads of caveats and apprehension)
- an upgrade to CodeMirror 6
Testing
composer test
License
The MIT License (MIT). Please see License File for more information.