This plugin adds help article management to Filament with both admin and frontend capabilities.
| Filament | Filament Help |
|---|---|
| 4.x | 1.x |
You can install the package via composer:
composer require tapp/filament-helpYou can publish and run the migrations with:
php artisan vendor:publish --tag="filament-help-migrations"
php artisan migrateYou can publish the config file with:
php artisan vendor:publish --tag="filament-help-config"This is the contents of the published config file:
return [
'navigation' => [
'admin' => [
'register' => true,
'sort' => 1,
'icon' => 'heroicon-o-question-mark-circle',
'group' => 'Help',
],
'frontend' => [
'register' => true,
'sort' => 1,
'icon' => 'heroicon-o-question-mark-circle',
'label' => 'Help',
],
],
];Add this plugin to a panel on plugins() method.
E.g. in app/Providers/Filament/AdminPanelProvider.php:
use Tapp\FilamentHelp\FilamentHelpPlugin;
public function panel(Panel $panel): Panel
{
return $panel
// ...
->plugins([
FilamentHelpPlugin::make(),
//...
]);
}Add this plugin to a panel for frontend access:
use Tapp\FilamentHelp\FilamentHelpFrontendPlugin;
public function panel(Panel $panel): Panel
{
return $panel
// ...
->plugins([
FilamentHelpFrontendPlugin::make(),
//...
]);
}- Admin Panel: Full CRUD operations for help articles
- Frontend: Read-only access to public help articles
- Rich Content: HTML content support with iframe embedding
- Public/Private: Control article visibility
- Search & Filter: Find articles by name and filter by public status
composer testPlease see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.