PHPackages                             rtablada/flat-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. rtablada/flat-docs

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

rtablada/flat-docs
==================

39JavaScript

Since Jun 13Pushed 13y ago1 watchersCompare

[ Source](https://github.com/rtablada/flatdocs)[ Packagist](https://packagist.org/packages/rtablada/flat-docs)[ RSS](/packages/rtablada-flat-docs/feed)WikiDiscussions master Synced 2d ago

READMEChangelogDependenciesVersions (1)Used By (0)

FlatDoc for Laravel 4
---------------------

[](#flatdoc-for-laravel-4)

This clean Markdown utility allows you to make awesome documentation quickly.

Installation with [Laravel 4 Package Installer](https://github.com/rtablada/package-installer)
----------------------------------------------------------------------------------------------

[](#installation-with-laravel-4-package-installer)

Simply run `php artisan package:install rtablada/flat-docs`

Installation with Composer
--------------------------

[](#installation-with-composer)

In your composer.json add `'rtablada/flat-docs': 'dev-master'`

Then in your app/config/app.php add this to your Service Providers `'Rtablada\FlatDocs\FlatDocsServiceProvider',`

Publishing assets and configuration
-----------------------------------

[](#publishing-assets-and-configuration)

Finally run these few commands:

```
php artisan asset:publish rtablada/flat-docs
php artisan config:publish rtablada/flat-docs
```

Cofiguration
------------

[](#cofiguration)

You can modify the configuration

Creating your docs
------------------

[](#creating-your-docs)

### Declaring docs

[](#declaring-docs)

Register the docs you would like available by modifying the 'registeredDocs' property in the config file. This will handle URI mapping as well as creating your navigation! Also, you can declare stubs vs. Pretty Titles by using the format `stub:pretty`. By the way, there is no limitation to the depths of your uris/documents!

```
'registeredDocs' => array(
	'start:Getting Started',
	'api' => array(
		'1:endpoint1',
		'2:endpoint2',
	),
),
```

### Markdown Files

[](#markdown-files)

In your app path, place your docs in a 'docs' folder (this location can be modified in the config). There order should match the way you want your uris. So the file tree for the example would look like:

```
start.md
api/
	-1.md
	-2.md

```

###  Health Score

21

—

LowBetter than 18% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity41

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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/ea9ccd400c74151601341e320935a31d1a9779c5eb49a8f364bc7a0ac75baa32?d=identicon)[rtablada](/maintainers/rtablada)

---

Top Contributors

[![rtablada](https://avatars.githubusercontent.com/u/2532004?v=4)](https://github.com/rtablada "rtablada (9 commits)")

### Embed Badge

![Health badge](/badges/rtablada-flat-docs/health.svg)

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

PHPackages © 2026

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