PHPackages                             erikaheidi/autodocs - 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. [CLI & Console](/categories/cli)
4. /
5. erikaheidi/autodocs

ActiveLibrary[CLI & Console](/categories/cli)

erikaheidi/autodocs
===================

Reference Documentation Builder

0.2.0(2y ago)18439MITPHP

Since Sep 6Pushed 1y ago2 watchersCompare

[ Source](https://github.com/erikaheidi/autodocs)[ Packagist](https://packagist.org/packages/erikaheidi/autodocs)[ Docs](https://github.com/erikaheidi/autodocs)[ RSS](/packages/erikaheidi-autodocs/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (2)Dependencies (4)Versions (5)Used By (0)

Autodocs is a PHP library designed to facilitate building highly customizable automated docs based on markdown templates and JSON data sources. It provides a layer of abstraction on top of which you can create your own documentation factory.

Autodocs was built to be combined with a [Minicli](https://docs.minicli.dev) application, making it suitable for running as a scheduled task on GitHub Actions.

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

[](#requirements)

- PHP >= 8.2
- Composer
- ext-json

Visit the [Autodocs Wiki](https://github.com/erikaheidi/autodocs/wiki) for architecture details and basic documentation.

Tutorial
--------

[](#tutorial)

For a detailed guide on how to implement an Autodocs application, check the tutorial on DEV: [Creating an Automated Documentation Pipeline in PHP with Autodocs and GitHub Actions](https://dev.to/erikaheidi/creating-an-automated-documentation-pipeline-in-php-with-autodocs-and-github-actions-1464). It covers everything from bootstrapping a new Minicli app and configuring it with Autodocs, creating a custom documentation page, setting up a JSON data source, and setting up a custom layout for a README page. The tutorial also covers how to create a GitHub Actions workflow to run this application and create a pull request when there are changes in the generated docs.

Demo
----

[](#demo)

A demo implementation that generates JSON-based README files is available in this repo:

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance29

Infrequent updates — may be unmaintained

Popularity20

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity36

Early-stage or recently created project

 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.

###  Release Activity

Cadence

Every ~2 days

Total

2

Last Release

976d ago

### Community

Maintainers

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

---

Top Contributors

[![erikaheidi](https://avatars.githubusercontent.com/u/293241?v=4)](https://github.com/erikaheidi "erikaheidi (23 commits)")

---

Tags

clidocumentation

###  Code Quality

TestsPest

### Embed Badge

![Health badge](/badges/erikaheidi-autodocs/health.svg)

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

###  Alternatives

[symfony/console

Eases the creation of beautiful and testable command line interfaces

9.8k1.1B11.3k](/packages/symfony-console)[nunomaduro/termwind

It's like Tailwind CSS, but for the console.

2.5k239.8M286](/packages/nunomaduro-termwind)[wp-cli/php-cli-tools

Console utilities for PHP

68325.0M367](/packages/wp-cli-php-cli-tools)

PHPackages © 2026

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