README

This repo can be used to scaffold a Laravel package. Follow these steps to get started:

1. Press the "Use template" button at the top of this repo to create a new repo with the contents of this laravel-backpack-help-docs
2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files
3. Remove this block of text.
4. Have fun creating your package.
5. If you need help creating a package, consider picking up our Laravel Package Training video course.

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

composer require pentangle/laravel-backpack-help-docs

You can publish and run the migrations with:

php artisan vendor:publish --provider="pentangle\LaravelBackpackHelpDocs\LaravelBackpackHelpDocsServiceProvider" --tag="laravel-backpack-help-docs-migrations"
php artisan migrate

php artisan backpack:add-sidebar-content "<li class='nav-item'><a class='nav-link' href='{{ backpack_url('help-doc') }}'><i class='nav-icon la la-question'></i> Help docs</a></li>"
php artisan backpack:add-sidebar-content "<x-help-docs-widget/>"

You can publish the config file with:

php artisan vendor:publish --provider="pentangle\LaravelBackpackHelpDocs\LaravelBackpackHelpDocsServiceProvider" --tag="laravel-backpack-help-docs-config"

This is the contents of the published config file:

return [
];

Usage

$laravel-backpack-help-docs = new pentangle\LaravelBackpackHelpDocs();
echo $laravel-backpack-help-docs->echoPhrase('Hello, pentangle!');

Testing

composer test

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

• Pentangle
• All Contributors

License

The MIT License (MIT). Please see License File for more information.