README

Filament Knowledge Base

A Filament plugin for jeffersongoncalves/laravel-knowledge-base that provides Admin, User, and Guest panels for complete knowledge base management.

Compatibility

Installation

You can install the package via composer:

composer require jeffersongoncalves/filament-knowledge-base:"^3.0"

Publish the configuration (optional):

php artisan vendor:publish --tag="filament-knowledge-base-config"

Usage

Admin Panel

Full management capabilities: categories, articles, versions, feedback, related articles, and SEO.

use JeffersonGoncalves\FilamentKnowledgeBase\KnowledgeBasePlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            KnowledgeBasePlugin::make()
                ->versioning(true)
                ->feedback(true)
                ->relatedArticles(true)
                ->seo(true)
                ->navigationGroup('Knowledge Base'),
        ]);
}

Resources: Category (hierarchical, sortable), Article (with status, visibility, SEO fields).

Relation Managers: Versions (read-only history), Feedback (helpful/not helpful), Related Articles (attach/detach with sort order).

Widgets: Knowledge Base Overview (total articles, published, drafts, categories, views, helpful rate).

User Panel

Read-only access to published articles for authenticated users, with feedback capability.

use JeffersonGoncalves\FilamentKnowledgeBase\KnowledgeBaseUserPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            KnowledgeBaseUserPlugin::make()
                ->feedback(true)
                ->navigationGroup('Knowledge Base'),
        ]);
}

Resources: Article (published/public only, view with feedback buttons).

Pages: Knowledge Base (search and browse by category).

Widgets: Popular Articles (top 5 by view count).

Guest Panel

Public read-only access without authentication. No feedback capability.

use JeffersonGoncalves\FilamentKnowledgeBase\KnowledgeBaseGuestPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            KnowledgeBaseGuestPlugin::make()
                ->navigationGroup('Knowledge Base'),
        ]);
}

Resources: Article (published/public only, view with view count increment).

Pages: Knowledge Base (search and browse by category).

Widgets: Popular Articles (top 5 by view count).

Feature Toggles

Each plugin supports fluent feature toggles:

Features can also be toggled globally in config/filament-knowledge-base.php.

Plugin Comparison

Localization

Translations are provided for:

• English (en)
• Brazilian Portuguese (pt_BR)

Publish translations to customize:

php artisan vendor:publish --tag="filament-knowledge-base-translations"

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

License

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