erikaheidi / autodocs
Reference Documentation Builder
Requires
- minicli/minicli: ^4.2
- minicli/stencil: ^0.2.1
Requires (Dev)
- mockery/mockery: ^1.6
- pestphp/pest: ^2.16
This package is auto-updated.
Last update: 2024-11-25 12:32:07 UTC
README
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 application, making it suitable for running as a scheduled task on GitHub Actions.
Requirements
- PHP >= 8.2
- Composer
- ext-json
Visit the Autodocs Wiki for architecture details and basic documentation.
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. 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
A demo implementation that generates JSON-based README files is available in this repo: https://github.com/erikaheidi/autodocs-demo