README

Autodocs 是一个 PHP 库，旨在简化基于 markdown 模板和 JSON 数据源的自动化文档的构建。它提供了一层抽象，可以在此基础上创建自己的文档工厂。

Autodocs 是为了与 Minicli 应用程序结合使用而构建的，使其适合在 GitHub Actions 上作为计划任务运行。

要求

PHP >= 8.2
Composer
ext-json

有关架构细节和基本文档的详细信息，请访问 Autodocs Wiki。

教程

有关如何实现 Autodocs 应用的详细指南，请查看 DEV 上的教程：使用 Autodocs 和 GitHub Actions 在 PHP 中创建自动化文档流程。它涵盖了从启动新的 Minicli 应用程序并将其与 Autodocs 配置，创建自定义文档页面，设置 JSON 数据源，到设置 README 页面的自定义布局的整个过程。教程还介绍了如何创建 GitHub Actions 工作流程来运行此应用程序，并在生成的文档有更改时创建拉取请求。

演示

此存储库中提供了一个生成基于 JSON 的 README 文件的演示实现：https://github.com/erikaheidi/autodocs-demo

erikaheidi / autodocs

维护者

详细信息

README

要求

教程

演示