negreanucalin / multidoc-laravel
0.1.9
2021-11-24 15:04 UTC
Requires
- illuminate/support: 8.70.*
- negreanucalin/multidoc-parser: ~0.1
- negreanucalin/multidoc-viewer: ~0.1
Requires (Dev)
- graham-campbell/testbench: ^5.6
- phpunit/phpunit: 9.5.10
README
Not yet stable, in testing phase!
Laravel wrapper that uses the Multidoc parser and Multidoc viewer
Instalation
Just add "negreanucalin/multidoc-laravel": "^1.0"
in your composer.json
Laravel configuration
-
Add the service provider and alias
- Providers
\MultidocLaravel\MultidocServiceProvider::class
- Aliases
'MultidocLaravel'=>\Multidoc\Facades\MultidocLaravelFacade::class
- Providers
-
Publish vendors Run:
php artisan vendor:publish --tag=multidoc
-
(SPA+Api integration)
Route::get('/{any}', function () { return ... })->where('any', '^(?!api|multidoc).*$');
-
Generate documentation
- Documentation folder is
documentation
inside the root of your application (check Multidoc parser ) - Run:
php artisan multidoc:generate
- Documentation folder is
-
Test it
- Go to:
{{yourAppName}}/multidoc
- Go to: