雪软/documentarian

维护者

详细信息

github.com/snowsoft/documentarian

源代码

安装: 38

依赖: 1

建议者: 0

安全性: 0

星标: 0

关注者: 0

分支: 91

语言：JavaScript

0.0.2 2023-03-15 11:44 UTC

Requires

Requires (Dev)

MIT ecda6002601ed90033cf6b1c84422823494c036e

  • Marcel Pociot <m.pociot.woop@gmail.com>

This package is auto-updated.

Last update: 2024-09-15 15:26:13 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 Lord在TripIt工作期间构建的。

Documentarian是由Marcel Pociot构建的。