bchalier/documentarian

安装: 118

依赖项: 1

建议者: 0

安全性: 0

星标: 0

关注者: 0

分支: 91

语言:JavaScript

0.5.1 2021-09-30 06:41 UTC

This package is auto-updated.

Last update: 2024-09-29 05:56:57 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构建的。