appstore-1panel/apps/showdoc
2024-03-01 16:02:20 +08:00
..
3.2.4 chore(deps): update star7th/showdoc docker tag to v3.2.4 (#762) 2023-12-28 22:03:34 +08:00
arm-latest feat: showdoc 增加 arm 版本 (#649) 2023-12-03 12:47:44 +08:00
data.yml feat: 统一修改应用描述信息 2024-03-01 16:02:20 +08:00
logo.png feat: add ShowDoc (#480) 2023-10-10 02:38:45 -05:00
README.md feat: add ShowDoc (#480) 2023-10-10 02:38:45 -05:00

ShowDoc

ShowDoc 是一个非常适合IT团队的在线API文档、技术文档工具。通过showdoc你可以方便地使用markdown语法来书写出美观的API文档、数据字典文档、技术文档、在线excel文档等等。如果不想编辑markdown文档你还可以利用showdoc的自动化能力从程序注释中自动生成API文档或者从搭配的RunApi客户端类似postman的api调试工具中一边调试接口、一边自动生成文档。通过分配项目成员和团队成员你可以很方便地进行项目文档的权限管理和团队协作也可以分享文档出去给朋友查看。ShowDoc还支持多平台客户端有win客户端、mac客户端、ios、android等更方便跨平台使用。

主要功能:

  • API文档随着移动互联网的发展BaaS后端即服务越来越流行。服务端提供APIAPP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档。
  • 数据字典:一份好的数据字典可以很方便地向别人说明你的数据库结构,如各个字段的释义等。
  • 说明文档你完全可以使用showdoc来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅。