PHPackages                             barnythorpe/clarify - 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. barnythorpe/clarify

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

barnythorpe/clarify
===================

A CLI command for your PHP projects to convert PHPDoc into MarkDown based documentation.

0.1.0(1y ago)014[3 issues](https://github.com/Barny-Thorpe/clarify/issues)3MITPHPCI passing

Since Apr 16Pushed 1y ago1 watchersCompare

[ Source](https://github.com/Barny-Thorpe/clarify)[ Packagist](https://packagist.org/packages/barnythorpe/clarify)[ RSS](/packages/barnythorpe-clarify/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (8)Versions (2)Used By (3)

```
   ________  ___       ________  ________  ___  ________ ___    ___
  |\   ____\|\  \     |\   __  \|\   __  \|\  \|\  _____\\  \  /  /|
  \ \  \___|\ \  \    \ \  \|\  \ \  \|\  \ \  \ \  \__/\ \  \/  / /
   \ \  \    \ \  \    \ \   __  \ \   _  _\ \  \ \   __\\ \    / /
    \ \  \____\ \  \____\ \  \ \  \ \  \\  \\ \  \ \  \_| \/  /  /
     \ \_______\ \_______\ \__\ \__\ \__\\ _\\ \__\ \__\__/  / /
      \|_______|\|_______|\|__|\|__|\|__|\|__|\|__|\|__|\___/ /
                                                       \|___|/

```

> Convert PHPDoc comments into structured Markdown documentation with ease.

About
-----

[](#about)

This project provides a **PHP-based documentation generator** that extracts **PHPDoc comments** from your code and converts them into **Markdown files**. Using a flexible **configuration system**, it allows you to **customize the output structure** with a comprehensible fluent interface.

🔧 Installation
--------------

[](#-installation)

1️⃣ **Install via Composer:**

```
composer require --dev barnythorpe/clarify
```

2️⃣ **Run the Documentation Generator:**

```
./vendor/bin/clarify build --config=clarify.config.php
```

or add to your composer.json as a script like so:

```
"scripts": {
   "doc": "clarify"
},
```

and run:

```
composer doc
```

🛠 Configuration Example
-----------------------

[](#-configuration-example)

Create a config file `clarify.config.php`:

```