PHPackages                             elevenlab/documentarian - 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. elevenlab/documentarian

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

elevenlab/documentarian
=======================

0.2.3(8y ago)030Apache 2JavaScriptPHP >=5.5.9

Since May 10Pushed 8y ago2 watchersCompare

[ Source](https://github.com/eleven-lab/documentarian)[ Packagist](https://packagist.org/packages/elevenlab/documentarian)[ RSS](/packages/elevenlab-documentarian/feed)WikiDiscussions master Synced 2mo ago

READMEChangelogDependencies (5)Versions (10)Used By (0)

Documentarian
=============

[](#documentarian)

#### Simply write beautiful API documentation.

[](#simply-write-beautiful-api-documentation)

This project is a fork of the original [Documentarian](https://github.com/mpociot/documentarian) PHP porting of [Slate](https://github.com/tripit/slate) API documentation tool. This fork will allow you to build API documentation for multiple API versions.

> If PHP is not your thing and you're more into nodeJS, why not give [Whiteboard](https://github.com/mpociot/whiteboard) a try?

[![Documentarian](https://camo.githubusercontent.com/190174cf3c6a539183197a0cf5e0a73104dc04dd61867e401966a79d270d985e/687474703a2f2f6d617263656c706f63696f742e64652f6769742f7768697465626f6172645f726573706f6e736976652e6a7067)](http://marcelpociot.de/whiteboard/)

### Installation

[](#installation)

To install Documentarian globally run

```
    $ composer global require elevenlab/documentarian
```

### Create documentation

[](#create-documentation)

To create a documentation project run

```
    $ documentarian create
```

if `folder` is not specified the documentation will be created in the current working directory.

#### Example:

[](#example)

```
    $ documentarian create kittens-api
```

### Create docs for specific api version

[](#create-docs-for-specific-api-version)

To create an api-specific documentation run the following command

```
    $ documentarian create_version
```

A folder named `` will be created in `/source/`. Edit the `index.md`file in this folder to customize your api-specific documentation.

#### Example

[](#example-1)

```
    $ documentarian create_version kittens-api v1
    $ documentarian create_version kittens-api v2
```

### Generate documentation pages

[](#generate-documentation-pages)

To generate `.html` files of the api-specific documentation run the command

```
    $ documentarian generate
```

where `` is your documentation parent folder. This will create a `public` folder inside your `` that contains both frontend assets (like css and javascript) and the generated `.html` pages of your api documentation versions.

#### Example

[](#example-2)

```
    $ documentarian generate kittens-api
```

The above command will generate a `public` folder inside `kittens-api` that consists of the following content:

- `css` folder - contains style assets
- `images` folder - contains images used in the documentation
- `js` folder - contains JavaScript scripts used by the documentation page
- `v1.html` file - Documentation page for api version `v1`
- `v2.html` file - Documentation page for api version `v2`

### Changing template structure

[](#changing-template-structure)

If you wish to change the documentation file template, edit the file `/views/index.blade.php`as you like.

### Setting version links

[](#setting-version-links)

To setup versions links that points to the right api version documentation page, edit the section `version` in `index.md`:

```
versions:
  v1:
    link: v1.html
    target: _blank
  v2:
    name: latest
    link: v2.html
```

For each version you can set the following parameters:

- `link` - Link of the documentation page (href)
- `target` - Target of `href` link (see [HTML target attribute](https://www.w3schools.com/tags/att_a_target.asp))
- `name` - Custom version name to be displayed on the rendered page, leave blank if you wish to use plain version name

### In depth documentation

[](#in-depth-documentation)

For further documentation on how to customize theme and other aspects, read the official whiteboard [documentation](http://marcelpociot.de/documentarian/installation).

### Slate / Whiteboard compatibility

[](#slate--whiteboard-compatibility)

Since both Documentarian and Slate use regular markdown files to render the API documentation, your existing Slate API documentation should work just fine. If you encounter any issues, please [submit an issue](https://github.com/mpociot/documentarian/issues).

### Contributors

[](#contributors)

Slate was built by [Robert Lord](https://lord.io) while at [TripIt](http://tripit.com).

Documentarian was built by Marcel Pociot.

Multi-version Documentarian was built by Valerio Cervo @ [Eleven](http://moveax.it)

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity7

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity54

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 65.2% 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 ~47 days

Recently: every ~93 days

Total

9

Last Release

3282d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/6773486?v=4)[Valerio Cervo](/maintainers/desh901)[@desh901](https://github.com/desh901)

---

Top Contributors

[![mpociot](https://avatars.githubusercontent.com/u/804684?v=4)](https://github.com/mpociot "mpociot (15 commits)")[![desh901](https://avatars.githubusercontent.com/u/6773486?v=4)](https://github.com/desh901 "desh901 (7 commits)")[![pashamesh](https://avatars.githubusercontent.com/u/1695806?v=4)](https://github.com/pashamesh "pashamesh (1 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/elevenlab-documentarian/health.svg)

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

###  Alternatives

[yajra/laravel-datatables-oracle

jQuery DataTables API for Laravel

4.9k33.8M339](/packages/yajra-laravel-datatables-oracle)[mpociot/documentarian

3773.3M31](/packages/mpociot-documentarian)[cknow/laravel-money

Laravel Money

1.0k4.3M22](/packages/cknow-laravel-money)[livewire/flux

The official UI component library for Livewire.

9385.0M86](/packages/livewire-flux)[akaunting/laravel-money

Currency formatting and conversion package for Laravel

7825.3M18](/packages/akaunting-laravel-money)[psalm/plugin-laravel

Psalm plugin for Laravel

3274.9M308](/packages/psalm-plugin-laravel)

PHPackages © 2026

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