PHPackages                             krak/peridocs - 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. [Utility & Helpers](/categories/utility)
4. /
5. krak/peridocs

ActiveLibrary[Utility & Helpers](/categories/utility)

krak/peridocs
=============

Peridot plugin for generating markdown documentation from your tests

v0.1.0(6y ago)0541MITPHP

Since Feb 22Pushed 6y ago1 watchersCompare

[ Source](https://github.com/krakphp/peridocs)[ Packagist](https://packagist.org/packages/krak/peridocs)[ RSS](/packages/krak-peridocs/feed)WikiDiscussions master Synced 3d ago

READMEChangelog (1)Dependencies (4)Versions (2)Used By (1)

Peridocs
========

[](#peridocs)

Peridocs is a Peridot plugin that generates automated markdown documentation from your peridot tests. I've found that my peridot tests are usually the best source of documentation. This project allows you to utilize your test documentation in an automated way.

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

[](#installation)

Load with composer as a dev dependency: `krak/peridocs`.

In your `peridot.php` configuration file, add the following:

```