lozhkindm/documentarian

安装次数: 1,519

依赖者: 1

建议者: 0

安全性: 0

星标: 0

关注者: 0

分支: 91

语言:JavaScript

0.4.3 2020-11-02 11:10 UTC

This package is auto-updated.

Last update: 2024-08-29 05:13:12 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构建的。