PHPackages vlotysh/filament-docs - 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. [Utility & Helpers](/categories/utility) 4. / 5. vlotysh/filament-docs ActiveLibrary[Utility & Helpers](/categories/utility) vlotysh/filament-docs ===================== Documentation system for Filament with TipTap editor, hierarchical pages, wiki-links, and static HTML export v0.0.1(3mo ago)035MITPHPPHP ^8.2 Since Jan 24Pushed 3mo agoCompare [ Source](https://github.com/vlotysh/filament-docs)[ Packagist](https://packagist.org/packages/vlotysh/filament-docs)[ RSS](/packages/vlotysh-filament-docs/feed)WikiDiscussions main Synced 1mo ago READMEChangelogDependencies (4)Versions (2)Used By (0) Filament Docs ============= [](#filament-docs) Documentation system for Laravel Filament with TipTap editor, hierarchical pages, wiki-links, and export to HTML/PDF. Features -------- [](#features) - **TipTap WYSIWYG Editor** - rich text editing with media uploads - **Hierarchical Pages** - unlimited nesting with drag & drop reordering - **Wiki-Links** - Obsidian-style cross-references `[[slug]]` or `[[slug|Display Text]]` - **Backlinks** - automatic tracking of pages that link to current page - **Full-Text Search** - Meilisearch integration via Laravel Scout - **Privacy Modes** - public / admin-only / password-protected - **Multilingual** - Spatie Translatable support (uk/en or any locales) - **Export to HTML** - static site with offline images (base64) - **Export to PDF** - single file with table of contents Requirements ------------ [](#requirements) - PHP 8.1+ - Laravel 10+ - Filament 3.x - FilamentTiptapEditor Installation ------------ [](#installation) ``` composer require vlotysh/filament-docs ``` Publish config and migrations: ``` php artisan vendor:publish --tag=filament-docs-config php artisan vendor:publish --tag=filament-docs-migrations php artisan migrate ``` Register the plugin in your Filament panel: ``` // app/Providers/Filament/AdminPanelProvider.php use Vlotysh\FilamentDocs\FilamentDocsPlugin; public function panel(Panel $panel): Panel { return $panel // ... ->plugins([ FilamentDocsPlugin::make(), ]); } ``` Configuration ------------- [](#configuration) Config file: `config/filament-docs.php` ``` return [ // Visibility: 'public', 'admin', or 'password' 'default_visibility' => env('DOCS_VISIBILITY', 'admin'), // Route prefixes 'route_prefix' => 'docs', 'api_prefix' => 'api/docs', // Middleware 'admin_middleware' => ['web', 'auth', 'admin'], 'public_middleware' => ['web'], // Features 'features' => [ 'search' => true, 'export' => true, 'wiki_links' => true, ], // Media storage disk 'media_disk' => env('DOCS_MEDIA_DISK', 'public'), // Custom admin check (optional) 'admin_check' => null, // fn($user) => $user->hasRole('admin'), ]; ``` ### Visibility Modes [](#visibility-modes) ModeDescription`public`Anyone can view docs`admin`Only authenticated admins`password`Password protected (set in admin panel)API Endpoints ------------- [](#api-endpoints) ``` GET /api/docs - Navigation tree GET /api/docs/pages - All pages list GET /api/docs/{slug} - Page content with prev/next GET /api/docs/search?q= - Search pages POST /api/docs/verify-password - Verify password (for password mode) ``` Wiki-Links ---------- [](#wiki-links) Use Obsidian-style syntax in content: ``` [[getting-started]] → Links to page with slug "getting-started" [[getting-started|Get Started]] → Links with custom display text [[admin/users]] → Links to nested page ``` Broken links are highlighted in red. Backlinks appear at the bottom of each page. Export ------ [](#export) From the admin panel (Doc Pages list): - **Export to HTML** - Downloads ZIP with static HTML files, inline CSS, and base64 images - **Export to PDF** - Downloads single PDF with cover page and table of contents Frontend Integration -------------------- [](#frontend-integration) Example React integration: ``` // API service export const docsAPI = { getNavigation: () => api.get('/api/docs'), getPage: (slug) => api.get(`/api/docs/${slug}`), search: (query) => api.get('/api/docs/search', { params: { q: query } }), }; // Usage const { data } = await docsAPI.getPage('getting-started'); // data: { title, content, breadcrumb, children, prev, next, backlinks } ``` Search Setup (Optional) ----------------------- [](#search-setup-optional) For full-text search, configure Laravel Scout with Meilisearch: ``` composer require meilisearch/meilisearch-php ``` ``` SCOUT_DRIVER=meilisearch MEILISEARCH_HOST=http://localhost:7700 MEILISEARCH_KEY=your-master-key ``` ``` php artisan scout:import "Vlotysh\FilamentDocs\Models\DocPage" ``` License ------- [](#license) MIT ### Health Score 34 — LowBetter than 77% of packages Maintenance79 Regular maintenance activity Popularity7 Limited adoption so far Community6 Small or concentrated contributor base Maturity36 Early-stage or recently created project Bus Factor1 Top contributor holds 100% 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 Unknown Total 1 Last Release 109d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/635fdfd4d458c9076d2932ce5728cea053853315260015511c1c69b5e9c88cfc?d=identicon)[vlotysh](/maintainers/vlotysh) --- Top Contributors [![vlotysh](https://avatars.githubusercontent.com/u/5550544?v=4)](https://github.com/vlotysh "vlotysh (2 commits)") --- Tags laraveltiptapdocumentationwikifilament ### Embed Badge ![Health badge](/badges/vlotysh-filament-docs/health.svg) ``` [![Health](https://phpackages.com/badges/vlotysh-filament-docs/health.svg)](https://phpackages.com/packages/vlotysh-filament-docs) ``` ### Alternatives [pboivin/filament-peek Full-screen page preview modal for Filament 253319.6k12](/packages/pboivin-filament-peek)[dotswan/filament-map-picker Easily pick and retrieve geo-coordinates using a map-based interface in your Filament applications. 124139.3k2](/packages/dotswan-filament-map-picker)[jibaymcs/filament-tour Bring the power of DriverJs to your Filament panels and start a tour ! 12247.8k](/packages/jibaymcs-filament-tour)[aymanalhattami/filament-context-menu context menu (right click menu) for filament 9838.0k](/packages/aymanalhattami-filament-context-menu)[tapp/filament-google-autocomplete-field Filament plugin that provides a Google Autocomplete field 3098.1k](/packages/tapp-filament-google-autocomplete-field)[defstudio/filament-searchable-input A searchable autocomplete input for Filament forms 3212.4k](/packages/defstudio-filament-searchable-input) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)