PHPackages                             objective-php/docu-mentor - 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. [Parsing & Serialization](/categories/parsing)
4. /
5. objective-php/docu-mentor

ActiveLibrary[Parsing & Serialization](/categories/parsing)

objective-php/docu-mentor
=========================

Tool to generate Objective-php's markdown documentation

v1.0.4(6y ago)0186[1 issues](https://github.com/objective-php/docu-mentor/issues)2GPL-3.0PHPPHP >=7.0

Since Jun 20Pushed 6y ago5 watchersCompare

[ Source](https://github.com/objective-php/docu-mentor)[ Packagist](https://packagist.org/packages/objective-php/docu-mentor)[ Docs](https://github.com/objective-php/docu-mentor)[ RSS](/packages/objective-php-docu-mentor/feed)WikiDiscussions master Synced 4d ago

READMEChangelogDependencies (3)Versions (6)Used By (2)

ObjectivePHP \\ DocuMentor
==========================

[](#objectivephp--documentor)

Introduction
------------

[](#introduction)

We always wanted to make our framework Objective PHP serviceable for every person who get interested getting an use of it. We tried to write documentation in many ways but we choose to write a tool to generate a custom markdown documentation for every components.

Description
-----------

[](#description)

Docu-mentor is a CLI tool for the documentation generation for packages.

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

[](#installation)

### Composer

[](#composer)

The easiest way to install the library and get ready to play with it is by using Composer. Run the following command :

```
composer require objective-php/docu-mentor

```

The command will be accessible in ./vendor/bin

Configuration directive documentation guides
--------------------------------------------

[](#configuration-directive-documentation-guides)

For :

- [Scalar](/docs/03.Scalar.md)
- [Complex](/docs/04.Complex.md)
- [Example-Values](/docs/05.Example-Values.md)

How to use
----------

[](#how-to-use)

### Usage

[](#usage)

```
php docu [OPTIONS]

    -i, --init      Generate the docs/.md files
    -c, --configs   Update the config-directive doc file
    -v, --verbose   Shows the errors
    -vv, -vvv       Shows the errors more expressly
    -f, --force     Overwrite the docs
    -h,-u, --help,--usage
                    Show this message
     --config-dir=[path]
                    Specify a custom path for the configs
     --docs-dir=[path]
                    Specify a custom path for output directory
     --composer-file=[path]
                    Specify a custom path for composer.json

```

### Examples:

[](#examples)

Init the whole documentation:

```
    php docu -ic
```

Rewrite the config doc:

```
    php docu -c -v
```

Rewrite and debug your config:

```
    php docu -c -vvv
```

Reset the docs:

```
    php docu -i --force
```

Custom pathes:

```
    php docu -ic --config-dir=./docs/ --docs-dir=./Config
```

The whole documentation
-----------------------

[](#the-whole-documentation)

Full documentation can be found at [objective-php.org](http://objective-php.org/)

###  Health Score

29

—

LowBetter than 59% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity10

Limited adoption so far

Community15

Small or concentrated contributor base

Maturity61

Established project with proven stability

 Bus Factor1

Top contributor holds 95.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 ~87 days

Total

5

Last Release

2540d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/6ed32dc08c012c25925ba618f54d5a6e52af3ff0d0cc6e42a7fed2b59dfca28e?d=identicon)[bcerati](/maintainers/bcerati)

---

Top Contributors

[![louis-cuny](https://avatars.githubusercontent.com/u/13121784?v=4)](https://github.com/louis-cuny "louis-cuny (20 commits)")[![gauthier](https://avatars.githubusercontent.com/u/32955?v=4)](https://github.com/gauthier "gauthier (1 commits)")

---

Tags

docmarkdownobjective php

### Embed Badge

![Health badge](/badges/objective-php-docu-mentor/health.svg)

```
[![Health](https://phpackages.com/badges/objective-php-docu-mentor/health.svg)](https://phpackages.com/packages/objective-php-docu-mentor)
```

###  Alternatives

[erusev/parsedown

Parser for Markdown.

15.0k151.8M732](/packages/erusev-parsedown)[league/commonmark

Highly-extensible PHP Markdown parser which fully supports the CommonMark spec and GitHub-Flavored Markdown (GFM)

2.9k404.0M702](/packages/league-commonmark)[michelf/php-markdown

PHP Markdown

3.5k52.4M345](/packages/michelf-php-markdown)[league/html-to-markdown

An HTML-to-markdown conversion helper for PHP

1.9k28.6M199](/packages/league-html-to-markdown)[cebe/markdown

A super fast, highly extensible markdown parser for PHP

1.0k32.5M136](/packages/cebe-markdown)[justinwalsh/daux.io

Documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly

4.6k38.1k1](/packages/justinwalsh-dauxio)

PHPackages © 2026

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