Knowledge Base for your filament panels

This plugin adds a markdown powered knowledge base to your filament app. You write markdown files, and the package turns them into a fully navigable documentation panel with a sidebar, breadcrumbs, a table of contents and global search.

A companion plugin integrates the knowledge base into your regular panels: a help menu on your resources and pages, documentation previews in modals and a link to the knowledge base in the sidebar.

Documentation

The full documentation is available at guava.cz.

Version compatibility

For older filament versions, please check the branch of the respective version.

Installation

You can install the package via composer:

composer require guava/filament-knowledge-base

Next, install @tailwindcss/typography if you don't have it already, since we use prose to style the markdown output:

npm install -D @tailwindcss/typography

Then publish the package assets:

php artisan filament:assets

Finally, make sure you have a custom filament theme (read here how to create one) and add the following to your theme.css file so the CSS is properly built:

@plugin "@tailwindcss/typography";
@source '../../../../vendor/guava/filament-knowledge-base/src/**/*';
@source '../../../../vendor/guava/filament-knowledge-base/resources/views/**/*';

For the remaining setup steps, please see the installation docs.

Usage

The knowledge base needs its own panel. Register the KnowledgeBasePlugin on it:

use Guava\FilamentKnowledgeBase\Plugins\KnowledgeBasePlugin;

$panel->plugin(KnowledgeBasePlugin::make());

And the KnowledgeBaseCompanionPlugin on your regular panel(s):

use Guava\FilamentKnowledgeBase\Plugins\KnowledgeBaseCompanionPlugin;

$panel->plugin(KnowledgeBaseCompanionPlugin::make()
    ->knowledgeBasePanelId('knowledge-base')
);

Then create your first documentation page:

php artisan docs:make

Everything else, including the markdown features, modal previews, help menus and help actions, is covered in the documentation.

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

• Lukas Frey
• All Contributors
• Phiki - syntax highlighting
• league/commonmark - markdown parsing
• Spatie - Our package skeleton is a modified version of Spatie's Package Tools

License

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