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

Version	Filament	PHP	Laravel	Tailwind
1.x	^3.0	^8.1	^10.0	3.x
2.x	^4.0	^8.2	^11.0	4.x
3.x	^5.0	^8.2	^11.28	4.x

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).

Languages

When the core package is configured with more than one language (knowledge-base.locales), the article and category forms grow a tab per language and the article list grows a state per language.

Article form: one tab per language with that language's title, slug, excerpt, content and SEO fields, an authoritative language select and a per-language version status. The authoritative version follows the article's own status; every other language is published on its own. A “Mark other languages outdated” toggle (off by default) flags the other languages when you save the authoritative version.
Article list: a state per language (missing, draft, published, outdated), a Mark up to date action for outdated versions and an Outdated in language filter. Both the columns and the filter adapt to the configured languages.
Category form: one tab per language with that language's name, slug and description; the default language is required, the others are optional.

With a single configured language the forms, the list and the actions are exactly as above without a Languages section: nothing changes for single-language installs.

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:

Method	Default	Description
`versioning(bool)`	`true`	Article version history
`feedback(bool)`	`true`	Helpful/not helpful feedback
`relatedArticles(bool)`	`true`	Related articles management
`seo(bool)`	`true`	SEO fields (title, description, keywords)

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

Plugin Comparison

Feature	Admin	User	Guest
CRUD Categories	Yes	No	No
CRUD Articles	Yes	No	No
View Published Articles	All	Public only	Public only
Feedback	Manage	Submit	No
Versions	Manage	No	No
Related Articles	Manage	View	View
Search	Yes	Yes	Yes
Requires Auth	Yes	Yes	No

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.

Security Vulnerabilities

Please see SECURITY for details.

License

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

jeffersongoncalves / filament-knowledge-base

Package info

Security

Fund package maintenance!

Statistics