PHPackages jeffersongoncalves/filament-documentation - 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. jeffersongoncalves/filament-documentation ActiveLibrary[Admin Panels](/categories/admin) jeffersongoncalves/filament-documentation ========================================= A Filament plugin to add markdown-based documentation to your admin panel. v3.0.6(4mo ago)91.8k↑289.3%MITPHPPHP ^8.2CI passing Since Feb 21Pushed 1w ago1 watchersCompare [ Source](https://github.com/jeffersongoncalves/filament-documentation)[ Packagist](https://packagist.org/packages/jeffersongoncalves/filament-documentation)[ GitHub Sponsors](https://github.com/jeffersongoncalves)[ RSS](/packages/jeffersongoncalves-filament-documentation/feed)WikiDiscussions 3.x Synced 2d ago READMEChangelog (10)Dependencies (16)Versions (25)Used By (0) [![Filament Documentation](https://raw.githubusercontent.com/jeffersongoncalves/filament-documentation/3.x/art/jeffersongoncalves-filament-documentation.png)](https://raw.githubusercontent.com/jeffersongoncalves/filament-documentation/3.x/art/jeffersongoncalves-filament-documentation.png) Filament Documentation Plugin ============================= [](#filament-documentation-plugin) [![Latest Version on Packagist](https://camo.githubusercontent.com/b9679d77d9956edcd328f6d8ba4b74885b37e5b62e3ca57b813544baa7861a53/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6a6566666572736f6e676f6e63616c7665732f66696c616d656e742d646f63756d656e746174696f6e2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/jeffersongoncalves/filament-documentation)[![GitHub Tests Action Status](https://camo.githubusercontent.com/d5772eb58e2ece3651e3b33745398a20e3840e82c4b3cbb8661ad905a708c45d/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f6a6566666572736f6e676f6e63616c7665732f66696c616d656e742d646f63756d656e746174696f6e2f74657374732e796d6c3f6272616e63683d332e78266c6162656c3d7465737473267374796c653d666c61742d737175617265)](https://github.com/jeffersongoncalves/filament-documentation/actions?query=workflow%3Atests+branch%3A3.x)[![GitHub Code Style Action Status](https://camo.githubusercontent.com/88c1f836c1b193eaee4e3d995fce908081a964c27a9ddf0ed1d3c5bed8010bb3/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f6a6566666572736f6e676f6e63616c7665732f66696c616d656e742d646f63756d656e746174696f6e2f6669782d7068702d636f64652d7374796c652d6973737565732e796d6c3f6272616e63683d332e78266c6162656c3d636f64652532307374796c65267374796c653d666c61742d737175617265)](https://github.com/jeffersongoncalves/filament-documentation/actions?query=workflow%3A%22Fix+PHP+code+styling%22+branch%3A3.x) A Filament plugin to add **markdown-based documentation** directly inside your admin panel. Inspired by `nova-documentation`. Features -------- [](#features) - Read `.md` files from a configurable directory (`resources/docs/`) - Parse YAML frontmatter for title, order, and custom path - Render Markdown with GitHub Flavored Markdown support - Syntax highlighting via highlight.js with copy-to-clipboard - Dynamic sidebar with nested directory support (collapsible groups) - Heading permalinks for deep linking - Relative `.md` links auto-converted to panel routes - Light and dark mode support - Authorization control via policies - Configurable cache for parsed content - Artisan install command (`php artisan docs:install`) Version Compatibility --------------------- [](#version-compatibility) BranchFilamentLaravelPHPLivewire1.x3.x10+8.1+3.x2.x4.x11+8.2+3.x**3.x****5.x****12+****8.2+****4.x**Screenshots ----------- [](#screenshots) ScreenshotLightDarkDocs home[![docs-home](screenshots/light/docs-home.png)](screenshots/light/docs-home.png)[![docs-home](screenshots/dark/docs-home.png)](screenshots/dark/docs-home.png)Docs installation[![docs-installation](screenshots/light/docs-installation.png)](screenshots/light/docs-installation.png)[![docs-installation](screenshots/dark/docs-installation.png)](screenshots/dark/docs-installation.png)Docs configuration[![docs-configuration](screenshots/light/docs-configuration.png)](screenshots/light/docs-configuration.png)[![docs-configuration](screenshots/dark/docs-configuration.png)](screenshots/dark/docs-configuration.png)Docs advanced[![docs-advanced](screenshots/light/docs-advanced.png)](screenshots/light/docs-advanced.png)[![docs-advanced](screenshots/dark/docs-advanced.png)](screenshots/dark/docs-advanced.png)Installation ------------ [](#installation) You can install the package via composer: ``` composer require jeffersongoncalves/filament-documentation ``` Optionally, publish the config and example docs: ``` php artisan docs:install ``` Or publish individually: ``` php artisan vendor:publish --tag=filament-documentation-config php artisan vendor:publish --tag=filament-documentation-docs ``` Setup ----- [](#setup) Register the plugin in your `PanelProvider`: ``` use JeffersonGoncalves\FilamentDocumentation\FilamentDocumentationPlugin; public function panel(Panel $panel): Panel { return $panel ->plugins([ FilamentDocumentationPlugin::make() ->slug('docs') ->navigationLabel('Documentation') ->navigationIcon('heroicon-o-book-open') ->navigationGroup('Help') ->navigationSort(99) ->withAuthorization(false), ]); } ``` Writing Documentation --------------------- [](#writing-documentation) Place your `.md` files in `resources/docs/` (configurable via `config/filament-documentation.php`). ### Frontmatter [](#frontmatter) Each file supports optional YAML frontmatter: ``` --- title: "Getting Started" path: home order: 1 --- ``` KeyDescription`title`Page title (overrides first H1)`path`Custom URL slug`order`Sort order in sidebar### Nested Directories [](#nested-directories) Subdirectories become collapsible groups in the sidebar: ``` resources/docs/ ├── home.md ├── installation.md ├── configuration.md └── advanced/ ├── overview.md ├── authorization.md └── customization.md ``` ### Relative Links [](#relative-links) Link between docs using relative `.md` paths — they are automatically converted to panel routes: ``` - [Installation](installation.md) - [Advanced](advanced/overview.md) ``` Configuration ------------- [](#configuration) ``` // config/filament-documentation.php return [ 'title' => env('DOCS_TITLE', 'Documentation'), 'docs_path' => resource_path('docs'), 'home' => 'home.md', 'cache_minutes' => env('DOCS_CACHE', 10), // 0 to disable 'login_route' => null, ]; ``` Plugin Options -------------- [](#plugin-options) MethodDefaultDescription`slug()``'docs'`URL path: `/admin/docs``navigationLabel()``'Documentation'`Sidebar label`navigationIcon()``heroicon-o-book-open`Sidebar icon`navigationGroup()``null`Sidebar group`navigationSort()``99`Sort order`withAuthorization()``false`Require `viewDocumentation` gateAuthorization ------------- [](#authorization) Enable authorization to restrict access: ``` FilamentDocumentationPlugin::make() ->withAuthorization(true) ``` Then define a gate: ``` Gate::define('viewDocumentation', function ($user) { return $user->hasRole('admin'); }); ``` 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 see [SECURITY](.github/SECURITY.md) for details. License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE) for more information. ### Health Score 49 — FairBetter than 94% of packages Maintenance89 Actively maintained with recent releases Popularity27 Limited adoption so far Community10 Small or concentrated contributor base Maturity57 Maturing project, gaining track record Bus Factor1 Top contributor holds 80.4% 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 ~6 days Recently: every ~27 days Total 21 Last Release 13d ago Major Versions v2.0.2 → v3.0.22026-02-21 v1.0.3 → v3.0.42026-02-22 v1.0.4 → 3.0.52026-02-24 1.x-dev → 2.x-dev2026-04-26 2.x-dev → 3.x-dev2026-06-20 PHP version history (2 changes)v3.0.0PHP ^8.2 v1.0.0PHP ^8.1 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/411493?v=4)[Jefferson Gonçalves](/maintainers/jeffersongoncalves)[@jeffersongoncalves](https://github.com/jeffersongoncalves) --- Top Contributors [![jeffersongoncalves](https://avatars.githubusercontent.com/u/411493?v=4)](https://github.com/jeffersongoncalves "jeffersongoncalves (45 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (10 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (1 commits)") --- Tags admin-paneldocumentationfilamentfilament-pluginfilamentphplaravellivewiremarkdownphplaraveldocumentationmarkdownfilamentdocsfilamentphpadmin-panel ### Code Quality TestsPest Static AnalysisPHPStan Code StyleLaravel Pint ### Embed Badge ![Health badge](/badges/jeffersongoncalves-filament-documentation/health.svg) ``` [![Health](https://phpackages.com/badges/jeffersongoncalves-filament-documentation/health.svg)](https://phpackages.com/packages/jeffersongoncalves-filament-documentation) ``` ### Alternatives [mradder/filament-logger Audit logging, activity tracking, exports, alerts, and dashboards for Filament admin panels. 2317.4k](/packages/mradder-filament-logger)[relaticle/custom-fields User Defined Custom Fields for Laravel Filament 16354.2k](/packages/relaticle-custom-fields)[rawilk/profile-filament-plugin Profile & MFA starter kit for filament. 3914.6k](/packages/rawilk-profile-filament-plugin)[marcelweidum/filament-passkeys Use passkeys in your filamentphp app 6649.5k1](/packages/marcelweidum-filament-passkeys)[guava/filament-knowledge-base A filament plugin that adds a knowledge base and help to your filament panel(s). 209151.3k2](/packages/guava-filament-knowledge-base)[stephenjude/filament-jetstream A Laravel starter kit built with Filament inspired by Jetstream. 17760.2k3](/packages/stephenjude-filament-jetstream) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)