hahadu / documentarian
v0.3.0
2022-10-13 10:02 UTC
Requires
- php: >=7.0
- illuminate/view: ^8.0||^9.0
- mnapoli/front-yaml: ^2.0
- mnapoli/silly: ^1.7
- windwalker/renderer: ^4
Requires (Dev)
- phpunit/phpunit: ^4.8
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构建的。