hahadu/documentarian

安装: 56

依赖: 1

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 0

开放问题: 0

语言:JavaScript

v0.3.0 2022-10-13 10:02 UTC

This package is auto-updated.

Last update: 2024-09-13 14:21:39 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构建的。