PHPackages                             yamldocs/yamldocs - 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. yamldocs/yamldocs

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

yamldocs/yamldocs
=================

YAML Reference Builder / Markdown Document Generator

1.0.4(2y ago)165573[2 issues](https://github.com/yamldocs/yamldocs/issues)MITPHP

Since Nov 1Pushed 2y ago2 watchersCompare

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

READMEChangelog (10)Dependencies (5)Versions (34)Used By (0)

yamldocs
========

[](#yamldocs)

[![PHP Composer](https://github.com/erikaheidi/yamldocs/actions/workflows/php.yml/badge.svg)](https://github.com/erikaheidi/yamldocs/actions/workflows/php.yml)[![GitHub release (latest SemVer)](https://camo.githubusercontent.com/173dd326f4bc7af468ac6fb655dd409c221b084e4bd07970c1214c18a762806c/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f6572696b6168656964692f79616d6c646f63733f636f6c6f723d303042423030266c6162656c3d4c617465737426736f72743d73656d766572)](https://camo.githubusercontent.com/173dd326f4bc7af468ac6fb655dd409c221b084e4bd07970c1214c18a762806c/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f6572696b6168656964692f79616d6c646f63733f636f6c6f723d303042423030266c6162656c3d4c617465737426736f72743d73656d766572)[![GitHub](https://camo.githubusercontent.com/966787d8a1f2f06f9f1e4e2a8ae06963ec4de7feb61123b239442d7387e613f3/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f6572696b6168656964692f79616d6c646f6373)](https://camo.githubusercontent.com/966787d8a1f2f06f9f1e4e2a8ae06963ec4de7feb61123b239442d7387e613f3/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f6572696b6168656964692f79616d6c646f6373)[![Packagist Dependency Version](https://camo.githubusercontent.com/3c97b6419dc4037f857c5890c82c1f44bd1a8b680de861605eee6bce5b04c766/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646570656e64656e63792d762f6572696b6168656964692f79616d6c646f63732f6d696e69636c692f6d696e69636c69)](https://camo.githubusercontent.com/3c97b6419dc4037f857c5890c82c1f44bd1a8b680de861605eee6bce5b04c766/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646570656e64656e63792d762f6572696b6168656964692f79616d6c646f63732f6d696e69636c692f6d696e69636c69)[![Packagist Dependency Version](https://camo.githubusercontent.com/ec7b1da35bfc7dca17293338a8f8d40ba2edfb803d3f19f594b7fceae7e16bec/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646570656e64656e63792d762f6572696b6168656964692f79616d6c646f63732f73796d666f6e792f79616d6c)](https://camo.githubusercontent.com/ec7b1da35bfc7dca17293338a8f8d40ba2edfb803d3f19f594b7fceae7e16bec/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646570656e64656e63792d762f6572696b6168656964692f79616d6c646f63732f73796d666f6e792f79616d6c)

Yamldocs is a markdown document generator based on YAML files, written in PHP with Minicli. It can be used as a standalone app or included as a Composer bin command to be used within existing projects. It is useful to create automated reference docs that can be customized through templates and a common builder interface.

Check the [documentation website](https://yamldocs.dev) for installation and usage instructions.

Examples
--------

[](#examples)

### Example YAML

[](#example-yaml)

This YAML demonstrates the structure used to define a document and how the markdown is generated:

```
Section1: #structure is based on the actual yaml
  Item1: value0
  Item2: value1
  Item3:
    - value12
    - value13
  Item4: value2

Section2:
  Item1:
    - value12
    - value13
  Item2: value1
  Item3: value3
  Item4: value2

# The document is described in the _meta node, but there are no required fields. Markdown will be generated anyways,
# based on the structure of the YAML document.
_meta:
  # Each node has a description (info) and an array of items that will be presented as a table.
  Section1:
    info: Information about Section 1
    items:
      Item1: The first row
      Item2: The second row

  Section2:
    info: Information about Section 2
    items:
      Item3: The third row
      Item4: The fourth row
    # Setting up a custom example
    example: |
      Section2:
        Item1:
          - value01
          - value02
```

### Building a single document

[](#building-a-single-document)

```
./bin/yamldocs build markdown file=example.yaml output=example.md
```

### Generated markdown content:

[](#generated-markdown-content)

```
    ## example.yaml
    example.yaml YAML reference

    ## Section1
    Information about Section 1

    ### Reference

    | Directive | Expects                 |
    |-----------|-------------------------|
    | Item1     | (String) The first row  |
    | Item2     | (String) The second row |
    | Item3     | (Array)                 |
    | Item4     | (String)                |

    ### Example

    ```yaml
    Section1:
      Item1: value0
      Item2: value1
      Item3:
        - value12
        - value13
      Item4: value2

    ```

    ## Section2
    Information about Section 2

    ### Reference

    | Directive | Expects                 |
    |-----------|-------------------------|
    | Item1     | (Array)                 |
    | Item2     | (String)                |
    | Item3     | (String) The third row  |
    | Item4     | (String) The fourth row |

    ### Example

    ```yaml
    Section2:
      Item1:
        - value01
        - value02
    ```
```

### Building multiple documents

[](#building-multiple-documents)

Use the `build docs` command to build markdown docs for all YAML files in a directory. Add `--recursively` to build subdirs.

```
./bin/yamldocs build docs source=var/yaml output=var/output --recursive
```

For more information and detailed usage instructions, check the full docs at .

###  Health Score

30

—

LowBetter than 64% of packages

Maintenance18

Infrequent updates — may be unmaintained

Popularity22

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity57

Maturing project, gaining track record

 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 ~12 days

Total

22

Last Release

1034d ago

Major Versions

0.2.3 → v1.0.x-dev2022-11-21

0.3.4 → 1.0.02023-06-06

### 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 (62 commits)")

---

Tags

clidocumentationmarkdownphpyamlclidocumentationyaml

###  Code Quality

TestsPest

### Embed Badge

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

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

###  Alternatives

[j13k/yaml-lint

A compact command line utility for checking YAML file syntax

161.1M19](/packages/j13k-yaml-lint)[access9/dbtabledump

The database table dumper

1014.0k](/packages/access9-dbtabledump)

PHPackages © 2026

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