Download the PHP package paper-leaf/help-guide without Composer
On this page you can find all versions of the php package paper-leaf/help-guide. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download paper-leaf/help-guide
More information about paper-leaf/help-guide
Files in paper-leaf/help-guide
Package help-guide
Short Description Help Guide provides contextual help and guidance throughout your Filament application, making it easier for users to understand and navigate your application.
License MIT
Homepage https://github.com/paper-leaf/help-guide
Informations about the package help-guide
Help Guide
Help Guide provides contextual help and guidance throughout your Filament application, making it easier for users to understand and navigate your application.
Installation
You can install the package via composer:
[!IMPORTANT] If you have not set up a custom theme and are using Filament Panels follow the instructions in the Filament Docs first.
After setting up a custom theme add the plugin's views to your theme css file or your app's css file if using the standalone packages.
You can publish and run the migrations with:
You can publish the config file with:
Optionally, you can publish the views using
Usage
Ensure you have ->default() set on your primary panel you are intalling this plugin on.
Register the plugin within your default panel's definition.
The plugin can be customized in the following ways:
Ability to Manage the Guide
Set which users can access the "Manage Guide" section of the panel. Only users who have the specificied permission will see any edit functionality within the Help Guide.
Available Permissions
Define the list of permissions that users can have within the system. These need to be tied to Gates within Laravel. Then these permissions can be assigned to help pages, and only users with that permission can view that page.
Login URL
Specify the login URL of your main dashboard so unauthenticated users accessing the Help Guide are redirected to the correct login page.
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
- Sarah Tinga
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of help-guide with dependencies
filament/filament Version ^5.0
kisame76/filament-advanced-rich-editor Version ^1.3
spatie/laravel-package-tools Version ^1.15.0
wallacemartinss/filament-icon-picker Version ^2.0