PHPackages                             pxlrbt/laravel-docs - 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. pxlrbt/laravel-docs

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

pxlrbt/laravel-docs
===================

Render markdown documentation inside Laravel with a modern VitePress-inspired layout.

39201[3 PRs](https://github.com/pxlrbt/laravel-docs/pulls)PHPCI passing

Since Feb 9Pushed 2mo agoCompare

[ Source](https://github.com/pxlrbt/laravel-docs)[ Packagist](https://packagist.org/packages/pxlrbt/laravel-docs)[ RSS](/packages/pxlrbt-laravel-docs/feed)WikiDiscussions main Synced today

READMEChangelogDependenciesVersions (4)Used By (0)

Laravel Docs
============

[](#laravel-docs)

Render markdown documentation inside Laravel.

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

[](#requirements)

- PHP 8.2+
- Laravel 11 or 12

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

[](#installation)

```
composer require pxlrbt/laravel-docs
```

Publish the config and assets:

```
php artisan vendor:publish --tag=docs-config
php artisan vendor:publish --tag=docs-assets
```

Usage
-----

[](#usage)

Place markdown files in the configured root directory (default: `docs/`). Each file needs YAML frontmatter:

```
---
title: "Getting Started"
description: "An introduction to the app"
group: "Basics"
order: 0
---

Your markdown content here.
```

Pages are accessible at `/{url_prefix}/{slug}`, e.g. `/docs/getting-started`.

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

[](#configuration)

The config file (`config/docs.php`) supports multiple doc instances as a keyed array:

```
return [
    'default' => [
        'root' => env('DOCS_ROOT', 'docs'),           // Markdown files directory
        'url_prefix' => env('DOCS_URL_PREFIX', 'docs'),// URL path prefix
        'layout' => null,                              // Blade layout component to wrap content
        'requires_auth' => false,                      // Require authentication
        'auth_middleware' => ['auth'],                  // Middleware when auth is required
        'can_access_docs' => null,                     // Closure for fine-grained access control
        'has_navigation' => true,                      // Show sidebar navigation
        'has_sidebar' => true,                         // Show table of contents
        'has_pagination' => true,                      // Show prev/next page links
    ],
];
```

### Multiple Instances

[](#multiple-instances)

Define additional instances to serve separate doc sections with different configs:

```
return [
    'default' => [
        'root' => 'docs',
        'url_prefix' => 'docs',
    ],
    'api' => [
        'root' => 'docs/api',
        'url_prefix' => 'api-docs',
        'requires_auth' => true,
    ],
];
```

### Access Control

[](#access-control)

Use the `can_access_docs` callback for fine-grained access control:

```
'can_access_docs' => function ($user) {
    return $user?->isAdmin();
},
```

### Custom Layout

[](#custom-layout)

Wrap the docs in your app's layout by setting the `layout` option to a Blade component name:

```
'layout' => 'layouts.app',
```

When no layout is set, docs render as a standalone page with their own styles.

Features
--------

[](#features)

- GitHub-flavored markdown (tables, strikethrough, etc.)
- Auto-generated table of contents from h2/h3 headings
- Heading permalink anchors
- Sidebar navigation grouped by frontmatter `group`
- Prev/next page pagination
- Responsive design (mobile, tablet, desktop)
- Sidebar caching for performance
- Directory traversal protection

License
-------

[](#license)

MIT

###  Health Score

27

—

LowBetter than 47% of packages

Maintenance57

Moderate activity, may be stable

Popularity22

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity17

Early-stage or recently created project

 Bus Factor1

Top contributor holds 93.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/de2f0e928f16fab39bac058ab23744ed045a432404d1275a5a5258acbd368798?d=identicon)[pxlrbt](/maintainers/pxlrbt)

---

Top Contributors

[![pxlrbt](https://avatars.githubusercontent.com/u/22632550?v=4)](https://github.com/pxlrbt "pxlrbt (14 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (1 commits)")

### Embed Badge

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

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

###  Alternatives

[andegna/calender

If you ever want to convert Ethiopian Calender to any other calender system (like the Gregorian Calender) this is the right package for you. And by the way it also support Amharic date formatting and much much more.

7418.9k](/packages/andegna-calender)

PHPackages © 2026

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