PHPackages                             diagonal/laravel-docs-manager - 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 &amp; Helpers](/categories/utility)
4. /
5. diagonal/laravel-docs-manager

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

diagonal/laravel-docs-manager
=============================

A simple package to browse markdown files in Laravel project filesystems in local environments

01[4 PRs](https://github.com/Diagonal-HQ/laravel-docs-manager/pulls)BladeCI passing

Since Sep 8Pushed 1mo agoCompare

[ Source](https://github.com/Diagonal-HQ/laravel-docs-manager)[ Packagist](https://packagist.org/packages/diagonal/laravel-docs-manager)[ RSS](/packages/diagonal-laravel-docs-manager/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (6)Used By (0)

Laravel Docs Manager
====================

[](#laravel-docs-manager)

[![Latest Version on Packagist](https://camo.githubusercontent.com/27d3c5dd13da739f52b91101e031f0a6b20b2db3dfddf18d301bec269987af46/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f646961676f6e616c2f6c61726176656c2d646f63732d6d616e616765722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/diagonal/laravel-docs-manager)[![GitHub Tests Action Status](https://camo.githubusercontent.com/8d3234d2a76bde40dac84c969eb9dd152b890e6feab5c05e8b8bca7d962ff0b6/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f646961676f6e616c2f6c61726176656c2d646f63732d6d616e616765722f72756e2d74657374732e796d6c3f6272616e63683d6d61696e266c6162656c3d7465737473267374796c653d666c61742d737175617265)](https://github.com/diagonal/laravel-docs-manager/actions?query=workflow%3Arun-tests+branch%3Amain)[![GitHub Code Style Action Status](https://camo.githubusercontent.com/f173869cd9233039ac458d8f55bcbddb7adebca5ec6dbe2b330c6b62c121b940/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f646961676f6e616c2f6c61726176656c2d646f63732d6d616e616765722f6669782d7068702d636f64652d7374796c652d6973737565732e796d6c3f6272616e63683d6d61696e266c6162656c3d636f64652532307374796c65267374796c653d666c61742d737175617265)](https://github.com/diagonal/laravel-docs-manager/actions?query=workflow%3A%22Fix+PHP+code+style+issues%22+branch%3Amain)[![Total Downloads](https://camo.githubusercontent.com/4b7b68bf846b0affcc2bba4833920f8203693df78a951666860b376bd624581e/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f646961676f6e616c2f6c61726176656c2d646f63732d6d616e616765722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/diagonal/laravel-docs-manager)

A simple and elegant package to browse and view markdown files in your Laravel project through a web interface. Perfect for local development environments where you want to quickly access documentation, README files, and other markdown content directly from your browser.

The package automatically scans your project for markdown files and provides a clean, responsive interface to browse and read them with syntax highlighting and proper formatting.

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

[](#installation)

You can install the package via composer:

```
composer require --dev diagonal/laravel-docs-manager
```

That's it! The package will automatically register itself and be ready to use in your local development environment.

Usage
-----

[](#usage)

Once installed, the package automatically works out of the box. Simply visit `/docs` in your Laravel application to browse all markdown files in your project.

### Accessing the Docs Manager

[](#accessing-the-docs-manager)

- **Default URL**: `http://your-app.test/docs`
- **Automatic Discovery**: The package automatically scans your project for `.md` files
- **Local Environment Only**: By default, only enabled in local environments for security

### What You'll See

[](#what-youll-see)

- A clean, responsive interface listing all markdown files in your project
- Organized file tree structure
- Syntax-highlighted markdown rendering
- Search and navigation capabilities

### Configuration (Optional)

[](#configuration-optional)

The package works perfectly with zero configuration, but you can customize it if needed by publishing the config file:

```
php artisan vendor:publish --tag="laravel-docs-manager-config"
```

Available configuration options:

```
return [
    // Route prefix (default: 'docs')
    'route_prefix' => env('DOCS_MANAGER_ROUTE_PREFIX', 'docs'),

    // Enable/disable the package (default: local environment only)
    'enabled' => env('DOCS_MANAGER_ENABLED', app()->environment('local')),

    // Base path to scan for markdown files
    'base_path' => env('DOCS_MANAGER_BASE_PATH', base_path()),

    // Directories to include in the scan
    'include_directories' => [''],

    // Directories to exclude from the scan
    'exclude_directories' => [
        'vendor', 'node_modules', '.git', 'storage/framework',
        'storage/logs', 'bootstrap/cache', 'public/build', 'public/hot'
    ],

    // File patterns to exclude
    'exclude_files' => ['.env*', '*.log', 'composer.lock', 'package-lock.json', 'yarn.lock'],
];
```

### Customizing Views (Optional)

[](#customizing-views-optional)

If you want to customize the appearance, you can publish the views:

```
php artisan vendor:publish --tag="laravel-docs-manager-views"
```

Testing
-------

[](#testing)

```
composer test
```

Changelog
---------

[](#changelog)

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

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

[](#contributing)

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

Security Vulnerabilities
------------------------

[](#security-vulnerabilities)

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

Credits
-------

[](#credits)

- [Diagonal](https://github.com/Diagonal-HQ)
- [All Contributors](../../contributors)

License
-------

[](#license)

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

###  Health Score

22

—

LowBetter than 22% of packages

Maintenance60

Regular maintenance activity

Popularity1

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity19

Early-stage or recently created project

 Bus Factor1

Top contributor holds 83.3% 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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/3232eefe7d142bbefea95e6172b0ffd23b5e53ba0079410ecbd3b8b80e433cd4?d=identicon)[branick@godiagonal.com](/maintainers/branick@godiagonal.com)

---

Top Contributors

[![bdweix](https://avatars.githubusercontent.com/u/25019620?v=4)](https://github.com/bdweix "bdweix (15 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (2 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (1 commits)")

### Embed Badge

![Health badge](/badges/diagonal-laravel-docs-manager/health.svg)

```
[![Health](https://phpackages.com/badges/diagonal-laravel-docs-manager/health.svg)](https://phpackages.com/packages/diagonal-laravel-docs-manager)
```

###  Alternatives

[atomescrochus/laravel-string-similarities

Compare two string and get a similarity percentage

70160.1k2](/packages/atomescrochus-laravel-string-similarities)[96qbhy/lbscloud-sdk

LBS.云 PHP SDK

182.4k](/packages/96qbhy-lbscloud-sdk)[vohof/transmission

Awesome PHP JSON-RPC client library for Transmission

181.7k](/packages/vohof-transmission)

PHPackages © 2026

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