bchalier / documentarian
0.5.1
2021-09-30 06:41 UTC
Requires
- php: >=5.5.9
- illuminate/view: 5.*|^6.0|^7.0|^8.0
- mnapoli/front-yaml: ^1.5
- mnapoli/silly: ~1.0
- windwalker/renderer: 3.*
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构建的。