Home

Welcome to the autodocs wiki!

Autodocs is a PHP library designed to facilitate building highly customizable automated docs based on 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 application, making it suitable for running as a scheduled task on GitHub Actions.

Requirements

• PHP >= 8.2
• Composer
• ext-json

Demo

A demo implementation that generates JSON-based README files is available in this repo: https://github.com/erikaheidi/autodocs-demo