Download the PHP package guava/filament-knowledge-base without Composer
On this page you can find all versions of the php package guava/filament-knowledge-base. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download guava/filament-knowledge-base
More information about guava/filament-knowledge-base
Files in guava/filament-knowledge-base
Package filament-knowledge-base
Short Description A filament plugin that adds a knowledge base and help to your filament panel(s).
License MIT
Homepage https://github.com/guava/filament-knowledge-base
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package filament-knowledge-base
Knowledge Base for your filament panels
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.
Documentation
The full documentation is available at guava.cz.
Version compatibility
| Filament version | Plugin version |
|---|---|
| 3.x | 1.x |
| 4.x | 2.x |
| 5.x | 3.x |
For older filament versions, please check the branch of the respective version.
Installation
You can install the package via composer:
Next, install @tailwindcss/typography if you don't have it already, since we use prose to style the markdown output:
Then publish the package assets:
Finally, make sure you have a custom filament theme (read here how to create one) and add the following to your theme.css file so the CSS is properly built:
For the remaining setup steps, please see the installation docs.
Usage
The knowledge base needs its own panel. Register the KnowledgeBasePlugin on it:
And the KnowledgeBaseCompanionPlugin on your regular panel(s):
Then create your first documentation page:
Everything else, including the markdown features, modal previews, help menus and help actions, is covered in the documentation.
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Lukas Frey
- All Contributors
- Phiki - syntax highlighting
- league/commonmark - markdown parsing
- Spatie - Our package skeleton is a modified version of Spatie's Package Tools
License
The MIT License (MIT). Please see License File for more information.
All versions of filament-knowledge-base with dependencies
calebporzio/sushi Version ^2.5
filament/filament Version ^5.0
illuminate/contracts Version ^12.0|^13.0
league/commonmark Version ^2.4
n0sz/commonmark-marker-extension Version ^1.0
phiki/phiki Version ^2.0
spatie/laravel-package-tools Version ^1.14.0
spatie/php-structure-discoverer Version ^2.1
symfony/yaml Version ^7.0|^8.0