Filament Documentation
B 83 completedPipeline State
completedPipeline Metadata
AI Prompt
Catalog Information
Adds markdown-based documentation to a Filament admin panel for developers and administrators.
Description
This plugin integrates a markdown documentation system directly into a Filament admin panel, allowing developers and administrators to access technical information without leaving the dashboard. It reads .md files from a configurable directory, parses YAML frontmatter for titles, ordering, and custom paths, and renders the content using GitHub Flavored Markdown with syntax highlighting. A dynamic sidebar supports nested directories and collapsible groups, while heading permalinks and relative link conversion enable deep linking within the panel. The plugin offers light and dark mode support, authorization via Laravel policies, and configurable caching to improve performance. An Artisan install command simplifies setup and configuration, making it easy to add or update documentation on the fly.
الوصف
يتيح هذا المكوّن إضافة وثائق مبنية على Markdown داخل لوحة تحكم Filament، مما يتيح للمطورين والمسؤولين الوصول السريع إلى المعلومات التقنية دون الحاجة إلى تطبيق خارجي. يتم قراءة ملفات Markdown من مجلد قابل للتكوين، مع تحليل بيانات YAML في المقدمة لتحديد العنوان والترتيب والمسار المخصص. يُعرض المحتوى باستخدام تنسيق GitHub Flavored Markdown مع تمييز الصياغة البرمجية، مع إمكانية نسخ الكود إلى الحافظة. يتضمن المكوّن شريط جانبي ديناميكي يدعم المجموعات المتداخلة، وروابط عناوين قابلة للنسخ، وتحويل الروابط النسبية إلى مسارات داخل لوحة التحكم. يدعم التبديل بين الوضع الفاتح والداكن، ويتيح التحكم في الوصول عبر سياسات Laravel، مع إمكانية التخزين المؤقت للمحتوى لتحسين الأداء. يقدّم أمر Artisan لتثبيت الوثائق وتوليد ملفات التكوين، ما يسهل عملية الإعداد والتخصيص.
Novelty
6/10Tags
Technologies
Claude Models
Quality Score
Strengths
- CI/CD pipeline configured (github_actions)
- Good test coverage (77% test-to-source ratio)
- Low average code complexity \u2014 well-structured code
- Good security practices \u2014 no major issues detected
- Properly licensed project
Recommendations
- Add a linter configuration to enforce code style consistency
Security & Health
Languages
Frameworks
Concepts (2)
| Category | Name | Description | Confidence | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Repobility — the code-quality scanner for AI-generated software · https://repobility.com | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| auto_description | Project Description | !Filament Documentation | 80% | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| auto_category | Web Backend | web-backend | 70% | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Embed Badge
Add to your README:
