X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/b8e2d75014c89c9e345c3f940ec8743bd158df67..refs/pull/3072/head:/dev/docs/logical-theme-system.md diff --git a/dev/docs/logical-theme-system.md b/dev/docs/logical-theme-system.md index fc8e6646f..4d6ed719b 100644 --- a/dev/docs/logical-theme-system.md +++ b/dev/docs/logical-theme-system.md @@ -77,6 +77,32 @@ Theme::listen(ThemeEvents::APP_BOOT, function($app) { }); ``` +## Custom Commands + +The logical theme system supports adding custom [artisan commands](https://laravel.com/docs/8.x/artisan) to BookStack. These can be registered in your `functions.php` file by calling `Theme::registerCommand($command)`, where `$command` is an instance of `\Symfony\Component\Console\Command\Command`. + +Below is an example of registering a command that could then be ran using `php artisan bookstack:meow` on the command line. + +```php +line('Meow there!'); + } +} + +Theme::registerCommand(new MeowCommand); +``` + ## Custom Socialite Service Example The below shows an example of adding a custom reddit socialite service to BookStack. @@ -95,4 +121,18 @@ Theme::listen(ThemeEvents::APP_BOOT, function($app) { 'name' => 'Reddit', ], '\SocialiteProviders\Reddit\RedditExtendSocialite@handle'); }); +``` + +In some cases you may need to customize the driver before it performs a redirect. +This can be done by providing a callback as a fourth parameter like so: + +```php +Theme::addSocialDriver('reddit', [ + 'client_id' => 'abc123', + 'client_secret' => 'def456789', + 'name' => 'Reddit', +], '\SocialiteProviders\Reddit\RedditExtendSocialite@handle', function($driver) { + $driver->with(['prompt' => 'select_account']); + $driver->scopes(['open_id']); +}); ``` \ No newline at end of file