knuckleswtf / scribe by shalvah

Generate API documentation for humans from your Laravel codebase.✍
4,796,402
1,477
19
Package Data
Maintainer Username: shalvah
Package Create Date: 2020-05-02
Package Last Update: 2024-03-26
Home Page: https://scribe.knuckles.wtf/laravel/
Language: PHP
License: MIT
Last Refreshed: 2024-03-27 03:25:02
Package Statistics
Total Downloads: 4,796,402
Monthly Downloads: 217,557
Daily Downloads: 9,407
Total Stars: 1,477
Total Watchers: 19
Total Forks: 263
Total Open Issues: 64

Generate API documentation for humans from your Laravel codebase. Here's what the output looks like.

Latest Stable Version Total Downloads Build Status

Installation

PHP 7.2.5 and Laravel/Lumen 5.8 or higher are required.

composer require --dev knuckleswtf/scribe

Laravel

Publish the config file by running:

php artisan vendor:publish --provider="Knuckles\Scribe\ScribeServiceProvider" --tag=scribe-config

This will create a scribe.php file in your config folder.

Lumen

  • When using Lumen, you will need to run composer require knuckleswtf/scribe instead.
  • Register the service provider in your bootstrap/app.php:
$app->register(\Knuckles\Scribe\ScribeServiceProvider::class);
  • Copy the config file from vendor/knuckleswtf/scribe/config/scribe.php to your project as config/scribe.php. Then add to your bootstrap/app.php:
$app->configure('scribe');

Documentation

Check out the documentation at ReadTheDocs. Don't forget to check out the migration guide if you're coming from mpociot/laravel-apidoc-generator.

To learn how to contribute, see our contribution guide.