PHPackages                             hardimpactdev/librarian - 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. hardimpactdev/librarian

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

hardimpactdev/librarian
=======================

Structured documentation tooling for Laravel projects

0.0.2(3w ago)0167↓46.1%[2 PRs](https://github.com/hardimpactdev/librarian/pulls)MITPHPPHP ^8.4CI passing

Since May 18Pushed 2w agoCompare

[ Source](https://github.com/hardimpactdev/librarian)[ Packagist](https://packagist.org/packages/hardimpactdev/librarian)[ Docs](https://github.com/hardimpactdev/librarian)[ GitHub Sponsors](https://github.com/:vendor_name)[ RSS](/packages/hardimpactdev-librarian/feed)WikiDiscussions main Synced 1w ago

READMEChangelog (2)Dependencies (14)Versions (5)Used By (0)

Librarian
=========

[](#librarian)

Librarian gives Laravel projects a strict documentation structure for keeping product intent, code, and tests aligned.

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

[](#installation)

```
composer require hardimpactdev/librarian
php artisan vendor:publish --tag="librarian-config"
```

Usage
-----

[](#usage)

```
php artisan librarian:init
php artisan librarian:domain node
php artisan librarian:domains:normalize
php artisan librarian:build
php artisan librarian:lint
```

`librarian:init` creates the required documentation spine. Use `librarian:domain` to add ordered domain documentation, `librarian:build` to regenerate package-owned docs and lint them, and `librarian:lint` in CI for a read-only consistency check.

Optional Rules
--------------

[](#optional-rules)

Projects can opt into additional rules without changing Librarian's required spine. Register rule classes in `config/librarian.php`:

```
use HardImpact\Librarian\Linting\Rules\BulletComplexityRule;
use HardImpact\Librarian\Linting\Rules\CompoundNounStackRule;
use HardImpact\Librarian\Linting\Rules\DocumentComplexityRule;
use HardImpact\Librarian\Linting\Rules\LongSectionStructureRule;
use HardImpact\Librarian\Linting\Rules\RequirementSmellRule;
use HardImpact\Librarian\Linting\Rules\SectionOpenerProseRule;
use HardImpact\Librarian\Linting\Rules\SentenceCaseHeadingRule;
use HardImpact\Librarian\Linting\Rules\TableProseComplexityRule;

return [
    'path' => base_path('docs'),

    'rules' => [
        DocumentComplexityRule::class,
        RequirementSmellRule::class,
        SentenceCaseHeadingRule::class,
        LongSectionStructureRule::class,
        BulletComplexityRule::class,
        SectionOpenerProseRule::class,
        TableProseComplexityRule::class,
        [
            'rule' => CompoundNounStackRule::class,
            'options' => [
                'accepted_compounds' => [
                    'project-owned',
                ],
            ],
        ],
    ],
];
```

Testing
-------

[](#testing)

```
composer test
```

Changelog
---------

[](#changelog)

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

43

—

FairBetter than 89% of packages

Maintenance96

Actively maintained with recent releases

Popularity15

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity44

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

22d ago

### Community

Maintainers

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

---

Top Contributors

[![nckrtl](https://avatars.githubusercontent.com/u/18613261?v=4)](https://github.com/nckrtl "nckrtl (7 commits)")

---

Tags

laraveldocumentationhardimpactdevlibrarian

###  Code Quality

TestsPest

Static AnalysisPHPStan

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/hardimpactdev-librarian/health.svg)

```
[![Health](https://phpackages.com/badges/hardimpactdev-librarian/health.svg)](https://phpackages.com/packages/hardimpactdev-librarian)
```

###  Alternatives

[dedoc/scramble

Automatic generation of API documentation for Laravel applications.

2.1k9.9M87](/packages/dedoc-scramble)[spatie/laravel-data

Create unified resources and data transfer objects

1.8k33.0M871](/packages/spatie-laravel-data)[spatie/laravel-pdf

Create PDFs in Laravel apps

1.0k4.3M41](/packages/spatie-laravel-pdf)[codewithdennis/filament-select-tree

The multi-level select field enables you to make single selections from a predefined list of options that are organized into multiple levels or depths.

327482.0k25](/packages/codewithdennis-filament-select-tree)[nativephp/desktop

NativePHP for Desktop

37833.6k8](/packages/nativephp-desktop)[worksome/exchange

Check Exchange Rates for any currency in Laravel.

124581.3k](/packages/worksome-exchange)

PHPackages © 2026

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