pronabsen / mpociot-documentarian
从您的 Laravel 应用生成美观的 API 文档
3.0.0
2023-06-11 19:35 UTC
Requires
- mnapoli/front-yaml: ^2.0.2
- mnapoli/silly: ^1.8.2
- windwalker/renderer: ^4.0.27
This package is auto-updated.
Last update: 2024-09-11 22:07:35 UTC
README
简单编写美观的 API 文档。
========
此项目是流行的 Slate API 文档工具的 PHP 版本。
如果你不是 PHP 开发者,而是更倾向于使用 nodeJS,为什么不试试 Whiteboard 呢?
查看 Documentarian 的 示例 API 文档。
文档可在 http://marcelpociot.com/documentarian/installation 获取。
Slate / Whiteboard 兼容性
由于 Documentarian 和 Slate 都使用常规 markdown 文件来渲染 API 文档,您的现有 Slate API 文档应该可以正常工作。如果您遇到任何问题,请 提交问题。
深入文档
有关更多信息,请阅读 文档。
使用 Documentarian 构建的文档
请随意提交一个包含您的文档链接的 PR。
贡献者
Slate 是由 Robert Lord 在 TripIt 期间开发的。
Documentarian 是由 Marcel Pociot 开发的。