szwss / documentarian
0.3.0
2019-01-04 11:19 UTC
Requires
- php: >=5.5.9
- illuminate/view: 5.*
- 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文档应该可以正常工作。如果你遇到任何问题,请提交一个issue。
深入文档
有关进一步文档,请参阅文档。
使用Documentarian构建的文档
请随时提交包含你的文档链接的PR。
贡献者
Slate是由Robert Lord在TripIt期间构建的。
Documentarian是由Marcel Pociot构建的。