diviky/laravel-readme

Framework extension

v2.0.11 2025-08-09 07:17 UTC

Requires

• php: ^8.1
• league/commonmark: ^2.2
• spatie/laravel-markdown: ^2.3
• symfony/browser-kit: ^6.0

Requires (Dev)

• laravel/framework: ^9.5|^10.0

MIT

• Sankar Suda

• markdown
• laravel
• readme

README

    php artisan vendor:publish --provider="Diviky\Readme\ReadmeServiceProvider" --tag="config"

Add to your route config

Route::group(['middleware' => ['web']], function () {
    Route::get('docs/{version?}/{page?}', '\Diviky\Readme\Http\Controllers\Docs\Controller@index');
});

Replace variables

You can use the Laravel blade syntax inside markdown files to replace the variables and render conditions.

Variables wrapped between ## will be replaced with their corresponding values. ex: ##version## or ##domain##

License

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