README

This plugin adds help article management to Filament with both admin and frontend capabilities.

Version Compatibility

Filament	Filament Help
4.x	1.x

Installation

You can install the package via composer:

composer require tapp/filament-help

You can publish and run the migrations with:

php artisan vendor:publish --tag="filament-help-migrations"
php artisan migrate

You 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',
        ],
    ],
];

Using the Plugins

Admin Plugin

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(),
            //...
        ]);
}

Frontend Plugin

Add this plugin to a panel for frontend access:

use Tapp\FilamentHelp\FilamentHelpFrontendPlugin;
 
public function panel(Panel $panel): Panel
{
    return $panel
        // ...
        ->plugins([
            FilamentHelpFrontendPlugin::make(),
            //...
        ]);
}

Features

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

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.

tapp / filament-help

Maintainers

Details