vadikv/documentarian

安装次数: 9,535

依赖关系: 1

建议者: 0

安全: 0

星星: 0

关注者: 1

分支: 91

语言:JavaScript

0.4.1 2020-09-29 14:44 UTC

This package is auto-updated.

Last update: 2024-09-29 05:49:38 UTC


README

简单地编写漂亮的API文档。

========

image image codecov.io Scrutinizer Code Quality Build Status

该项目是流行的Slate API文档工具的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构建的。