PHPackages guava/filament-knowledge-base - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Admin Panels](/categories/admin) 4. / 5. guava/filament-knowledge-base ActiveLibrary[Admin Panels](/categories/admin) guava/filament-knowledge-base ============================= A filament plugin that adds a knowledge base and help to your filament panel(s). 3.3.2(3w ago)209164.0k—9%47[4 issues](https://github.com/GuavaCZ/filament-knowledge-base/issues)[1 PRs](https://github.com/GuavaCZ/filament-knowledge-base/pulls)2MITPHPPHP ^8.2CI passing Since May 4Pushed 2w ago3 watchersCompare [ Source](https://github.com/GuavaCZ/filament-knowledge-base)[ Packagist](https://packagist.org/packages/guava/filament-knowledge-base)[ Docs](https://github.com/guava/filament-knowledge-base)[ GitHub Sponsors](https://github.com/GuavaCZ)[ RSS](/packages/guava-filament-knowledge-base/feed)WikiDiscussions main Synced 2w ago READMEChangelog (10)Dependencies (74)Versions (58)Used By (2) [![filament-knowledge-base Banner](https://github.com/GuavaCZ/filament-knowledge-base/raw/main/.github/banner.png)](https://github.com/GuavaCZ/filament-knowledge-base/raw/main/.github/banner.png) Knowledge Base for your filament panels ======================================= [](#knowledge-base-for-your-filament-panels) [![Latest Version on Packagist](https://camo.githubusercontent.com/25cf0d5eeff06a683779c8107db1e0b431e0621319882209bc2d0de5ebd30909/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f67756176612f66696c616d656e742d6b6e6f776c656467652d626173652e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/guava/filament-knowledge-base)[![Total Downloads](https://camo.githubusercontent.com/ad477f0a3c434aab1dfd8247e6630b0ab0cf3c52e9c585d4d435ad9fc0adec0a/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f67756176612f66696c616d656e742d6b6e6f776c656467652d626173652e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/guava/filament-knowledge-base) 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. [![Showcase](https://github.com/GuavaCZ/filament-knowledge-base/raw/main/docs/3.x/_assets/screenshot_01.jpeg)](https://github.com/GuavaCZ/filament-knowledge-base/raw/main/docs/3.x/_assets/screenshot_01.jpeg) Documentation ------------- [](#documentation) The full documentation is available at [guava.cz](https://guava.cz/developers/packages/filament-knowledge-base?ref=github&utm_campaign=knowledge-base). Version compatibility --------------------- [](#version-compatibility) Filament versionPlugin version3.x1.x4.x2.x5.x3.xFor older filament versions, please check the branch of the respective version. Installation ------------ [](#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](https://filamentphp.com/docs/5.x/styling/overview#creating-a-custom-theme) 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](https://guava.cz/developers/packages/filament-knowledge-base/3.x/installation?ref=github&utm_campaign=knowledge-base). Usage ----- [](#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](https://guava.cz/developers/packages/filament-knowledge-base?ref=github&utm_campaign=knowledge-base). Testing ------- [](#testing) ``` composer test ``` Changelog --------- [](#changelog) Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. Contributing ------------ [](#contributing) Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details. Security Vulnerabilities ------------------------ [](#security-vulnerabilities) Please review [our security policy](../../security/policy) on how to report security vulnerabilities. Credits ------- [](#credits) - [Lukas Frey](https://github.com/GuavaCZ) - [All Contributors](../../contributors) - [Phiki](https://github.com/phikiphp/phiki) - syntax highlighting - [league/commonmark](https://commonmark.thephpleague.com/) - markdown parsing - Spatie - Our package skeleton is a modified version of [Spatie's Package Tools](https://github.com/spatie/laravel-package-tools) License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. ### Health Score 65 — FairBetter than 99% of packages Maintenance96 Actively maintained with recent releases Popularity53 Moderate usage in the ecosystem Community31 Small or concentrated contributor base Maturity68 Established project with proven stability Bus Factor1 Top contributor holds 77.1% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~15 days Total 55 Last Release 22d ago Major Versions 1.14.0 → 2.0.0-beta.12025-06-10 2.1.1 → 3.0.02026-01-24 2.1.2 → 3.0.12026-03-07 PHP version history (3 changes)1.0.0PHP ^8.1 1.0.2PHP ^8.2 1.13.0PHP ^8.1|^8.2 ### Community Maintainers ![](https://www.gravatar.com/avatar/42d872f5f47cd71cfd46c8fbd6ec77a6bfb46d6d9499b5e1f843eb407c07f737?d=identicon)[Skrypt](/maintainers/Skrypt) --- Top Contributors [![lukas-frey](https://avatars.githubusercontent.com/u/10926334?v=4)](https://github.com/lukas-frey "lukas-frey (199 commits)")[![skeemer](https://avatars.githubusercontent.com/u/864069?v=4)](https://github.com/skeemer "skeemer (18 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (8 commits)")[![pimeo](https://avatars.githubusercontent.com/u/1147117?v=4)](https://github.com/pimeo "pimeo (5 commits)")[![onairmarc](https://avatars.githubusercontent.com/u/50760632?v=4)](https://github.com/onairmarc "onairmarc (3 commits)")[![stereshko](https://avatars.githubusercontent.com/u/14062824?v=4)](https://github.com/stereshko "stereshko (3 commits)")[![fsamapoor](https://avatars.githubusercontent.com/u/4992968?v=4)](https://github.com/fsamapoor "fsamapoor (3 commits)")[![leek](https://avatars.githubusercontent.com/u/60204?v=4)](https://github.com/leek "leek (2 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (2 commits)")[![michaeld555](https://avatars.githubusercontent.com/u/97418627?v=4)](https://github.com/michaeld555 "michaeld555 (1 commits)")[![piotrdobrzynski](https://avatars.githubusercontent.com/u/50482622?v=4)](https://github.com/piotrdobrzynski "piotrdobrzynski (1 commits)")[![pxlrbt](https://avatars.githubusercontent.com/u/22632550?v=4)](https://github.com/pxlrbt "pxlrbt (1 commits)")[![Sjoerd24](https://avatars.githubusercontent.com/u/352099?v=4)](https://github.com/Sjoerd24 "Sjoerd24 (1 commits)")[![synsyst](https://avatars.githubusercontent.com/u/98920660?v=4)](https://github.com/synsyst "synsyst (1 commits)")[![ainesophaur](https://avatars.githubusercontent.com/u/4686198?v=4)](https://github.com/ainesophaur "ainesophaur (1 commits)")[![tbcy](https://avatars.githubusercontent.com/u/43423272?v=4)](https://github.com/tbcy "tbcy (1 commits)")[![andrew-southwell](https://avatars.githubusercontent.com/u/42930343?v=4)](https://github.com/andrew-southwell "andrew-southwell (1 commits)")[![Cyrille37](https://avatars.githubusercontent.com/u/368965?v=4)](https://github.com/Cyrille37 "Cyrille37 (1 commits)")[![damms005](https://avatars.githubusercontent.com/u/9839355?v=4)](https://github.com/damms005 "damms005 (1 commits)")[![danielbehrendt](https://avatars.githubusercontent.com/u/283437?v=4)](https://github.com/danielbehrendt "danielbehrendt (1 commits)") --- Tags laravelGuavafilament-knowledge-base ### Code Quality TestsPest Static AnalysisPHPStan Code StyleLaravel Pint ### Embed Badge ![Health badge](/badges/guava-filament-knowledge-base/health.svg) ``` [![Health](https://phpackages.com/badges/guava-filament-knowledge-base/health.svg)](https://phpackages.com/packages/guava-filament-knowledge-base) ``` ### Alternatives [rawilk/profile-filament-plugin Profile & MFA starter kit for filament. 3915.5k](/packages/rawilk-profile-filament-plugin)[backstage/mails View logged mails and events in a beautiful Filament UI. 16429.7k](/packages/backstage-mails)[mradder/filament-logger Audit logging, activity tracking, exports, alerts, and dashboards for Filament admin panels. 2324.4k1](/packages/mradder-filament-logger)[finity-labs/fin-mail A powerful email template manager and composer for Filament with dynamic token replacement, template versioning, and inline email sending. 316.8k2](/packages/finity-labs-fin-mail)[stephenjude/filament-debugger About 104173.6k2](/packages/stephenjude-filament-debugger)[tapp/filament-form-builder User facing form builder using Filament components 133.5k6](/packages/tapp-filament-form-builder) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)