通过
进行搜索
进行搜索payamjafari / documentarian
0.4.1
2020-12-21 10:43 UTC
Requires
- php: >=5.5.9
- 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开发的。