{"id":45408533,"url":"https://github.com/jeffersongoncalves/filament-documentation","last_synced_at":"2026-03-04T04:03:11.017Z","repository":{"id":339833614,"uuid":"1163533863","full_name":"jeffersongoncalves/filament-documentation","owner":"jeffersongoncalves","description":"A Filament plugin to add markdown-based documentation to your admin panel. Supports frontmatter, syntax highlighting, nested navigation, and dark mode.","archived":false,"fork":false,"pushed_at":"2026-02-21T21:34:50.000Z","size":92,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"3.x","last_synced_at":"2026-02-22T00:48:50.262Z","etag":null,"topics":["admin-panel","documentation","filament","filament-plugin","filamentphp","laravel","livewire","markdown","php"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jeffersongoncalves.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-02-21T19:22:02.000Z","updated_at":"2026-02-21T21:51:35.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/jeffersongoncalves/filament-documentation","commit_stats":null,"previous_names":["jeffersongoncalves/filament-documentation"],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/jeffersongoncalves/filament-documentation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeffersongoncalves%2Ffilament-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeffersongoncalves%2Ffilament-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeffersongoncalves%2Ffilament-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeffersongoncalves%2Ffilament-documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jeffersongoncalves","download_url":"https://codeload.github.com/jeffersongoncalves/filament-documentation/tar.gz/refs/heads/3.x","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeffersongoncalves%2Ffilament-documentation/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30071670,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-04T03:25:38.285Z","status":"ssl_error","status_checked_at":"2026-03-04T03:25:05.086Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["admin-panel","documentation","filament","filament-plugin","filamentphp","laravel","livewire","markdown","php"],"created_at":"2026-02-21T22:09:43.632Z","updated_at":"2026-03-04T04:03:11.012Z","avatar_url":"https://github.com/jeffersongoncalves.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv class=\"filament-hidden\"\u003e\n\n![Filament Documentation](https://raw.githubusercontent.com/jeffersongoncalves/filament-documentation/3.x/art/jeffersongoncalves-filament-documentation.png)\n\n\u003c/div\u003e\n\n# Filament Documentation Plugin\n\n[![Tests](https://github.com/jeffersongoncalves/filament-documentation/actions/workflows/tests.yml/badge.svg)](https://github.com/jeffersongoncalves/filament-documentation/actions/workflows/tests.yml)\n[![PHPStan](https://github.com/jeffersongoncalves/filament-documentation/actions/workflows/phpstan.yml/badge.svg)](https://github.com/jeffersongoncalves/filament-documentation/actions/workflows/phpstan.yml)\n[![Fix PHP Code Style](https://github.com/jeffersongoncalves/filament-documentation/actions/workflows/fix-php-code-style-issues.yml/badge.svg)](https://github.com/jeffersongoncalves/filament-documentation/actions/workflows/fix-php-code-style-issues.yml)\n[![Latest Version on Packagist](https://img.shields.io/packagist/v/jeffersongoncalves/filament-documentation.svg?style=flat-square)](https://packagist.org/packages/jeffersongoncalves/filament-documentation)\n\nA Filament plugin to add **markdown-based documentation** directly inside your admin panel. Inspired by `nova-documentation`.\n\n## Features\n\n- Read `.md` files from a configurable directory (`resources/docs/`)\n- Parse YAML frontmatter for title, order, and custom path\n- Render Markdown with GitHub Flavored Markdown support\n- Syntax highlighting via highlight.js with copy-to-clipboard\n- Dynamic sidebar with nested directory support (collapsible groups)\n- Heading permalinks for deep linking\n- Relative `.md` links auto-converted to panel routes\n- Light and dark mode support\n- Authorization control via policies\n- Configurable cache for parsed content\n- Artisan install command (`php artisan docs:install`)\n\n## Version Compatibility\n\n| Branch | Filament | Laravel | PHP | Livewire |\n|--------|----------|---------|-----|----------|\n| 1.x | 3.x | 10+ | 8.1+ | 3.x |\n| 2.x | 4.x | 11+ | 8.2+ | 3.x |\n| **3.x** | **5.x** | **12+** | **8.2+** | **4.x** |\n\n## Screenshots\n\n\u003c!-- SCREENSHOTS --\u003e\n| Screenshot | Light | Dark |\n|---|---|---|\n| Docs home | ![docs-home](screenshots/light/docs-home.png) | ![docs-home](screenshots/dark/docs-home.png) |\n| Docs installation | ![docs-installation](screenshots/light/docs-installation.png) | ![docs-installation](screenshots/dark/docs-installation.png) |\n| Docs configuration | ![docs-configuration](screenshots/light/docs-configuration.png) | ![docs-configuration](screenshots/dark/docs-configuration.png) |\n| Docs advanced | ![docs-advanced](screenshots/light/docs-advanced.png) | ![docs-advanced](screenshots/dark/docs-advanced.png) |\n\u003c!-- SCREENSHOTS --\u003e\n\n## Installation\n\n```bash\ncomposer require jeffersongoncalves/filament-documentation\n```\n\nOptionally, publish the config and example docs:\n\n```bash\nphp artisan docs:install\n```\n\nOr publish individually:\n\n```bash\nphp artisan vendor:publish --tag=filament-documentation-config\nphp artisan vendor:publish --tag=filament-documentation-docs\n```\n\n## Setup\n\nRegister the plugin in your `PanelProvider`:\n\n```php\nuse JeffersonGoncalves\\FilamentDocumentation\\FilamentDocumentationPlugin;\n\npublic function panel(Panel $panel): Panel\n{\n    return $panel\n        -\u003eplugins([\n            FilamentDocumentationPlugin::make()\n                -\u003eslug('docs')\n                -\u003enavigationLabel('Documentation')\n                -\u003enavigationIcon('heroicon-o-book-open')\n                -\u003enavigationGroup('Help')\n                -\u003enavigationSort(99)\n                -\u003ewithAuthorization(false),\n        ]);\n}\n```\n\n## Writing Documentation\n\nPlace your `.md` files in `resources/docs/` (configurable via `config/filament-documentation.php`).\n\n### Frontmatter\n\nEach file supports optional YAML frontmatter:\n\n```yaml\n---\ntitle: \"Getting Started\"\npath: home\norder: 1\n---\n```\n\n| Key | Description |\n|-----|-------------|\n| `title` | Page title (overrides first H1) |\n| `path` | Custom URL slug |\n| `order` | Sort order in sidebar |\n\n### Nested Directories\n\nSubdirectories become collapsible groups in the sidebar:\n\n```\nresources/docs/\n├── home.md\n├── installation.md\n├── configuration.md\n└── advanced/\n    ├── overview.md\n    ├── authorization.md\n    └── customization.md\n```\n\n### Relative Links\n\nLink between docs using relative `.md` paths — they are automatically converted to panel routes:\n\n```markdown\n- [Installation](installation.md)\n- [Advanced](advanced/overview.md)\n```\n\n## Configuration\n\n```php\n// config/filament-documentation.php\n\nreturn [\n    'title'         =\u003e env('DOCS_TITLE', 'Documentation'),\n    'docs_path'     =\u003e resource_path('docs'),\n    'home'          =\u003e 'home.md',\n    'cache_minutes' =\u003e env('DOCS_CACHE', 10),  // 0 to disable\n    'login_route'   =\u003e null,\n];\n```\n\n## Plugin Options\n\n| Method | Default | Description |\n|--------|---------|-------------|\n| `slug()` | `'docs'` | URL path: `/admin/docs` |\n| `navigationLabel()` | `'Documentation'` | Sidebar label |\n| `navigationIcon()` | `heroicon-o-book-open` | Sidebar icon |\n| `navigationGroup()` | `null` | Sidebar group |\n| `navigationSort()` | `99` | Sort order |\n| `withAuthorization()` | `false` | Require `viewDocumentation` gate |\n\n## Authorization\n\nEnable authorization to restrict access:\n\n```php\nFilamentDocumentationPlugin::make()\n    -\u003ewithAuthorization(true)\n```\n\nThen define a gate:\n\n```php\nGate::define('viewDocumentation', function ($user) {\n    return $user-\u003ehasRole('admin');\n});\n```\n\n## Testing\n\n```bash\ncomposer test\n```\n\n## Changelog\n\nPlease see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.\n\n## Contributing\n\nPlease see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.\n\n## Security\n\nPlease see [SECURITY](.github/SECURITY.md) for details.\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeffersongoncalves%2Ffilament-documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjeffersongoncalves%2Ffilament-documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeffersongoncalves%2Ffilament-documentation/lists"}