PHPackages                             elalecs/laravel-documenter - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. elalecs/laravel-documenter

ActiveLibrary[Utility & Helpers](/categories/utility)

elalecs/laravel-documenter
==========================

An automated documentation generator for Laravel and Filament projects. It analyzes your project structure, including models, Filament resources, controllers, jobs, events, middlewares, and rules, to create comprehensive Markdown documentation. Ideal for quickly onboarding new developers or maintaining an up-to-date project overview.

v1.0.1(1y ago)010MITPHPPHP ^7.3|^8.0

Since Aug 6Pushed 1y ago1 watchersCompare

[ Source](https://github.com/elalecs/laravel-documenter)[ Packagist](https://packagist.org/packages/elalecs/laravel-documenter)[ RSS](/packages/elalecs-laravel-documenter/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (6)Versions (3)Used By (0)

Laravel Documenter
==================

[](#laravel-documenter)

Laravel Documenter is an automated documentation generator for Laravel and Filament projects. Its primary purpose is to generate or extend the CONTRIBUTING.md file of your project, providing a comprehensive overview of your project's structure and components.

Features
--------

[](#features)

- Automatically generates or extends the CONTRIBUTING.md file in your Laravel project
- Documents key components: Models, Filament Resources, API Controllers, Jobs, Events, Middlewares, and Rules
- Uses customizable stubs for flexible documentation formatting
- Helps quickly onboard new developers by providing an up-to-date project overview
- Integrates seamlessly with Laravel and Filament projects

Requirements
------------

[](#requirements)

- PHP 7.3 or higher
- Laravel 8.0 or higher

Installation
------------

[](#installation)

You can install the package via composer:

```
composer require elalecs/laravel-documenter --dev
```

Configuration
-------------

[](#configuration)

Publish the configuration file:

```
php artisan vendor:publish --provider="Elalecs\LaravelDocumenter\LaravelDocumenterServiceProvider" --tag="config"
```

This will create a `config/laravel-documenter.php` file where you can customize the behavior of the package.

Usage
-----

[](#usage)

To generate or update your project's CONTRIBUTING.md file:

```
php artisan documenter:generate
```

This command will:

1. Analyze your project structure
2. Generate documentation for each component (Models, Filament Resources, etc.)
3. Create or update the CONTRIBUTING.md file in your project root

You can also generate documentation for specific components:

```
php artisan documenter:generate --type model
```

Available types are: `model`, `filament`, `api`, and `general`.

Customization
-------------

[](#customization)

You can customize the documentation output by publishing and modifying the stub files:

```
php artisan vendor:publish --provider="Elalecs\LaravelDocumenter\LaravelDocumenterServiceProvider" --tag="stubs"
```

This will copy the stub files to your `resources/views/vendor/laravel-documenter` directory. After publishing, update your `config/laravel-documenter.php` file to point to your custom stubs:

```
'stubs_path' => resource_path('views/vendor/laravel-documenter'),
```

Important: DocBlocks
--------------------

[](#important-docblocks)

For Laravel Documenter to function effectively, it's crucial that your code includes properly formatted DocBlocks. These DocBlocks should be present on:

- Classes
- Methods (especially `handle()` methods in Jobs and Middleware, and `passes()` methods in Rules)
- Properties

Include `@description` tags in your DocBlocks to provide detailed information about the purpose and functionality of your components.

Example:

```
/**
 * @description This job processes user uploads and generates thumbnails.
 */
class ProcessUserUpload implements ShouldQueue
{
    // ...
}
```

The more comprehensive your DocBlocks, the more detailed and useful the generated documentation will be.

Updating
--------

[](#updating)

When updating the package, make sure to republish the configuration file and clear the config cache:

```
composer update elalecs/laravel-documenter
php artisan vendor:publish --provider="Elalecs\LaravelDocumenter\LaravelDocumenterServiceProvider" --tag="config" --force
php artisan config:clear
```

Contributing
------------

[](#contributing)

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

For more details on how to contribute, please check our [CONTRIBUTING.md](CONTRIBUTING.md) file.

License
-------

[](#license)

The Laravel Documenter is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).

Credits
-------

[](#credits)

- [Alex Galindo](https://github.com/elalecs)

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance34

Infrequent updates — may be unmaintained

Popularity5

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity46

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

2

Last Release

642d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/9bfc8ef2808735e13ed4c1445141a7a6eae5b5fafdf37eb042fa104f35c37f78?d=identicon)[elalecs](/maintainers/elalecs)

---

Top Contributors

[![elalecs](https://avatars.githubusercontent.com/u/1626624?v=4)](https://github.com/elalecs "elalecs (10 commits)")

###  Code Quality

TestsPest

### Embed Badge

![Health badge](/badges/elalecs-laravel-documenter/health.svg)

```
[![Health](https://phpackages.com/badges/elalecs-laravel-documenter/health.svg)](https://phpackages.com/packages/elalecs-laravel-documenter)
```

###  Alternatives

[wireui/wireui

TallStack components

1.8k1.3M16](/packages/wireui-wireui)[livewire/volt

An elegantly crafted functional API for Laravel Livewire.

4195.3M84](/packages/livewire-volt)[blair2004/nexopos

The Free Modern Point Of Sale System build with Laravel, TailwindCSS and Vue.js.

1.2k2.3k](/packages/blair2004-nexopos)[stillat/proteus

Provides utilities for parsing and updating Laravel-style PHP configuration files.

17287.4k22](/packages/stillat-proteus)[ramonrietdijk/livewire-tables

Dynamic tables for models with Laravel Livewire

21147.4k](/packages/ramonrietdijk-livewire-tables)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)