Filament Knowledge Base

https://github.com/jeffersongoncalves/filament-knowledge-base
Admin
Filament Knowledge Base is a Filament plugin for Laravel that provides Admin, User, and Guest panels...
Tokens:3,268
Snippets:37
Trust Score:9.8
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install with Composer

Source: https://github.com/jeffersongoncalves/filament-knowledge-base/blob/3.x/resources/boost/skills/filament-knowledge-base-development/SKILL.md

Install the package via Composer. Requires Filament ^3.0, PHP ^8.1, Laravel ^10.0, and Tailwind 3.x.

```bash
composer require jeffersongoncalves/filament-knowledge-base:"^1.0"
```

--------------------------------

### Install filament-knowledge-base via Composer

Source: https://github.com/jeffersongoncalves/filament-knowledge-base/blob/3.x/README.md

Install the package via Composer. Requires version ^3.0 for Filament v5, PHP ^8.2, Laravel ^11.28, and Tailwind 4.x.

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

--------------------------------

### Publish Filament Knowledge Base Translations

Source: https://github.com/jeffersongoncalves/filament-knowledge-base/blob/3.x/README.md

Publishes the translation files for the Filament Knowledge Base plugin to customize them. Use this command after installation to override the default English and Brazilian Portuguese translations.

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

--------------------------------

### Publish filament-knowledge-base config

Source: https://github.com/jeffersongoncalves/filament-knowledge-base/blob/3.x/README.md

Publish the package configuration file. This step is optional.

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

--------------------------------

### Global Config (config/filament-knowledge-base.php)

Source: https://github.com/jeffersongoncalves/filament-knowledge-base/blob/3.x/resources/boost/skills/filament-knowledge-base-development/SKILL.md

Global configuration file for feature toggles. Set each feature to true or false to enable or disable it globally.

```php
return [
    'features' => [
        'versioning' => true,
        'feedback' => true,
        'related_articles' => true,
        'seo' => true,
    ],
];
```

--------------------------------

### Run Filament Knowledge Base Tests

Source: https://github.com/jeffersongoncalves/filament-knowledge-base/blob/3.x/README.md

Runs the test suite for the Filament Knowledge Base package. Execute this command in the project root to run all tests.

```bash
composer test
```

--------------------------------

### Register KnowledgeBaseGuestPlugin for guest panel

Source: https://github.com/jeffersongoncalves/filament-knowledge-base/blob/3.x/README.md

Register the KnowledgeBaseGuestPlugin for public read-only access without authentication. No feedback capability is available. The navigation group is set.

```php
use JeffersonGoncalves\FilamentKnowledgeBase\KnowledgeBaseGuestPlugin;

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

--------------------------------

### Register KnowledgeBasePlugin in panel

Source: https://github.com/jeffersongoncalves/filament-knowledge-base/blob/3.x/resources/boost/skills/filament-knowledge-base-development/SKILL.md

Registers the KnowledgeBasePlugin in the panel configuration. Required for the plugin to appear in the panel.

```php
->plugins([KnowledgeBasePlugin::make()])
```

--------------------------------

### Admin Plugin (Full CRUD)

Source: https://github.com/jeffersongoncalves/filament-knowledge-base/blob/3.x/resources/boost/skills/filament-knowledge-base-development/SKILL.md

Register the admin plugin in a Filament panel to enable full CRUD operations. Enables versioning, feedback, related articles, and SEO features, and sets navigation group, sort order, and icon.

```php
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')
                ->navigationSort(10)
                ->navigationIcon('heroicon-o-book-open'),
        ]);
}
```

--------------------------------

### Register KnowledgeBasePlugin in admin panel

Source: https://github.com/jeffersongoncalves/filament-knowledge-base/blob/3.x/README.md

Register the KnowledgeBasePlugin in the admin panel to enable full management capabilities: categories, articles, versions, feedback, related articles, and SEO. The plugin options enable versioning, feedback, related articles, SEO, and set the navigation group.

```php
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'),
        ]);
}
```

--------------------------------

### Feature Check Methods (has*())

Source: https://github.com/jeffersongoncalves/filament-knowledge-base/blob/3.x/resources/boost/skills/filament-knowledge-base-development/SKILL.md

Check feature availability using the has*() methods. Returns true only when both the plugin-level and config-level settings enable the feature.

```php
$plugin->hasVersioning();      // true only if both plugin and config enable it
$plugin->hasFeedback();        // true only if both plugin and config enable it
$plugin->hasRelatedArticles(); // true only if both plugin and config enable it
$plugin->hasSeo();             // true only if both plugin and config enable it
```

--------------------------------

### Register KnowledgeBaseUserPlugin for user panel

Source: https://github.com/jeffersongoncalves/filament-knowledge-base/blob/3.x/README.md

Register the KnowledgeBaseUserPlugin for authenticated users. Provides read-only access to published articles with feedback capability. The feedback option is enabled and the navigation group is set.

```php
use JeffersonGoncalves\FilamentKnowledgeBase\KnowledgeBaseUserPlugin;

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

--------------------------------

### Feature Toggles (Plugin Level)

Source: https://github.com/jeffersongoncalves/filament-knowledge-base/blob/3.x/resources/boost/skills/filament-knowledge-base-development/SKILL.md

Disable individual features via fluent methods on the plugin. Each method accepts a boolean to turn the feature off.

```php
// Disable specific features
KnowledgeBasePlugin::make()
    ->versioning(false)      // Disable version history
    ->feedback(false)        // Disable feedback
    ->relatedArticles(false) // Disable related articles
    ->seo(false);            // Disable SEO fields
```
Tokens:
Raw