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

ActiveLibrary

szwss/documentarian
===================

0.3.0(7y ago)0251Apache-2.0JavaScriptPHP >=5.5.9

Since May 10Pushed 7y ago1 watchersCompare

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

READMEChangelog (9)Dependencies (5)Versions (17)Used By (1)

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

[](#documentarian)

#### Simply write beautiful API documentation.

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

========

[![image](https://camo.githubusercontent.com/547d70c804145e5f0e454e0f5580b6a97721d0cd6c0ddefa0a0fe84a75ca5388/687474703a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6d706f63696f742f646f63756d656e74617269616e2e7376673f7374796c653d666c6174)](https://camo.githubusercontent.com/547d70c804145e5f0e454e0f5580b6a97721d0cd6c0ddefa0a0fe84a75ca5388/687474703a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6d706f63696f742f646f63756d656e74617269616e2e7376673f7374796c653d666c6174)[![image](https://camo.githubusercontent.com/6d7fc2c421bad59291a5e0ebb52e244a1e916499c8d3785ef50c8484dfa792f6/687474703a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f6d706f63696f742f646f63756d656e74617269616e2e7376673f7374796c653d666c6174)](https://camo.githubusercontent.com/6d7fc2c421bad59291a5e0ebb52e244a1e916499c8d3785ef50c8484dfa792f6/687474703a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f6d706f63696f742f646f63756d656e74617269616e2e7376673f7374796c653d666c6174)[![codecov.io](https://camo.githubusercontent.com/092e6aaf798dcc5677916a7e0f4ae9039647fbf2297ca500325628364f8b761f/68747470733a2f2f636f6465636f762e696f2f6769746875622f6d706f63696f742f646f63756d656e74617269616e2f636f7665726167652e7376673f6272616e63683d6d6173746572)](https://codecov.io/github/mpociot/documentarian?branch=master)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/7c214bc4152139f7e5be1b3bc0da8678b698f87bf75d4ffb3a2aa0d848130b79/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6d706f63696f742f646f63756d656e74617269616e2f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/mpociot/documentarian/?branch=master)[![Build Status](https://camo.githubusercontent.com/bd3030bb69006cc3d3dbc165f7d635da6d4a020485c7b9247942530636a74e4f/68747470733a2f2f7472617669732d63692e6f72672f6d706f63696f742f646f63756d656e74617269616e2e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/mpociot/documentarian)

This project is a PHP port of the popular [Slate](https://github.com/tripit/slate) API documentation tool.

> 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/)

Check out a Documentarian [example API documentation](http://marcelpociot.de/whiteboard/).

The documentation is available at [http://marcelpociot.com/documentarian/installation](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).

### In depth documentation

[](#in-depth-documentation)

For further documentation, read the [documentation](http://marcelpociot.de/documentarian/installation).

### Documentations built with Documentarian

[](#documentations-built-with-documentarian)

Feel free to submit a PR with a link to your documentation.

### Contributors

[](#contributors)

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

Documentarian was built by Marcel Pociot.

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity56

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 93.8% 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 ~64 days

Recently: every ~1 days

Total

16

Last Release

2682d ago

### Community

Maintainers

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

---

Top Contributors

[![mpociot](https://avatars.githubusercontent.com/u/804684?v=4)](https://github.com/mpociot "mpociot (15 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/szwss-documentarian/health.svg)

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

###  Alternatives

[yajra/laravel-datatables-oracle

jQuery DataTables API for Laravel

4.9k33.8M335](/packages/yajra-laravel-datatables-oracle)[laravel/cashier

Laravel Cashier provides an expressive, fluent interface to Stripe's subscription billing services.

2.5k25.9M106](/packages/laravel-cashier)[tightenco/jigsaw

Simple static sites with Laravel's Blade.

2.2k438.5k29](/packages/tightenco-jigsaw)[laravel/pulse

Laravel Pulse is a real-time application performance monitoring tool and dashboard for your Laravel application.

1.7k12.1M99](/packages/laravel-pulse)[mpociot/documentarian

3773.3M31](/packages/mpociot-documentarian)[livewire/flux

The official UI component library for Livewire.

9385.0M85](/packages/livewire-flux)

PHPackages © 2026

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