codise/documentarian

安装: 3

依赖项: 1

建议者: 0

安全性: 0

星标: 0

关注者: 0

分支: 91

语言:JavaScript

0.5.1 2022-04-22 12:03 UTC

This package is auto-updated.

Last update: 2024-09-22 17:12:23 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构建的。