toanld/documentarian

documentarian

安装: 4

依赖项: 1

建议者: 0

安全性: 0

星标: 0

关注者: 1

分支: 91

语言:JavaScript

0.3.0 2019-09-04 22:15 UTC

This package is auto-updated.

Last update: 2024-09-11 14:28:06 UTC


README

简单地编写美丽的API文档。

========

image image codecov.io Scrutinizer Code Quality Build Status

此项目是将流行的Slate API文档工具转换为PHP。

如果你不是PHP开发者,而是更倾向于使用nodeJS,为什么不尝试Whiteboard呢?

Documentarian

查看Documentarian的示例API文档

文档可在http://marcelpociot.com/documentarian/installation找到。

Slate / Whiteboard 兼容性

由于Documentarian和Slate都使用常规的Markdown文件来渲染API文档,因此您现有的Slate API文档应该可以正常工作。如果您遇到任何问题,请提交问题

深入文档

有关更多信息,请参阅文档

使用Documentarian构建的文档

请随意提交包含您文档链接的PR。

贡献者

Slate是在Robert LordTripIt任职期间构建的。

Documentarian是由Marcel Pociot构建的。