lai0n/documentarian

此包已被 废弃 并不再维护。未建议替代包。

安装: 27

依赖项: 1

建议者: 0

安全: 0

星标: 0

关注者: 0

分支: 90

语言:JavaScript

0.5.1 2021-07-16 11:53 UTC

This package is auto-updated.

Last update: 2023-08-16 16:50:11 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构建的。