hydreflab/documentarian

等待官方包升级到 Laravel 8.x

维护者

详情

github.com/HydrefLab/documentarian

源代码

安装量: 3,879

依赖者: 1

建议者: 0

安全性: 0

星标: 0

关注者: 1

分支: 91

语言:JavaScript

0.5.0 2020-09-18 10:04 UTC

Requires

Requires (Dev)

Apache 2 baef27630268239e233dec4304040f6c18e6793a

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

This package is auto-updated.

Last update: 2024-09-18 19:33:54 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 构建。