项目介绍

ShowDoc是一个非常适合IT团队的在线API文档、技术文档工具。通过showdoc，你可以方便地使用markdown语法来书写出美观的API文档、数据字典文档、技术文档、在线excel文档等等。如果不想编辑markdown文档，你还可以利用showdoc的自动化能力，从程序注释中自动生成API文档，或者从搭配的RunApi客户端（类似postman的api调试工具）中一边调试接口、一边自动生成文档。

目前超过100000+的互联网团队正在使用showdoc，包括知名公司内部的一些团队，比如腾讯、华为、百度、京东、字节跳动、顺丰等等。

适用场景

ShowDoc非常适合需要频繁分享和更新项目文档的IT团队，如软件开发团队、运维团队等。

支持平台

ShowDoc还支持多平台客户端，有win客户端、mac客户端、ios、android等，更方便跨平台使用。

功能特点

  • API文档：支持快速编写和分享API文档，便于前端和后端开发人员之间的协作。
  • 数据字典：可以轻松展示数据库结构，包括每个字段的定义，方便团队成员理解数据结构。
  • 解释文档：可用于编写工具说明或技术规范解释文档，供团队成员查询。
  • 分享与导出：支持响应式网页设计，可以将项目文档分享到电脑或移动设备上进行阅读，也可以导出为离线的Word文档。
  • 权限管理：项目分为公开项目和私有项目，私有项目需要登录才能访问，确保文档的安全性。
  • 项目转移：项目所有者可以自由地将项目转移给其他人。
  • 项目成员管理：可以轻松添加或删除项目成员，成员可以编辑文档，但无法转移或删除项目。
  • 编辑功能：支持Markdown编辑器，提供优秀的编辑和阅读体验。同时，提供了API接口模板和数据字典模板，减少了编辑工作。
  • 历史版本：提供历史版本功能，可以方便地恢复之前的版本。

宝塔面板安装

安装宝塔面板，前往宝塔面板官网，选择对应的脚本下载安装

部署

登录宝塔面板，在菜单栏中点击 Docker

首次会提示安装Docker和Docker Compose服务，点击立即安装，若已安装请忽略。

安装完成后在Docker-应用商店-实用工具中找到 Showdoc，点击安装（您也可以通过应用搜索功能直接搜索Showdoc）

设置域名等基本信息，点击确定

访问

  • 如您设置了域名，请直接在浏览器地址栏中输入域名访问，如http://demo.showdoc.com.cn，即可访问 Showdoc 控制台。
  • 如您选择了通过IP+Port访问，请在浏览器地址栏中输入域名访问 http://<宝塔面板IP>:15480，即可访问 Showdoc 控制台，如下图：

功能演示

版权声明：
1、本网站名称：帝企吧
2、本站永久网址：https://www.diqiba.com
3、本网站的文章部分内容可能来源于网络及作者投稿，仅供大家学习与参考，如有侵权，请联系站长进行删除处理。
4、本站一切资源不代表本站立场，并不代表本站赞同其观点和对其真实性负责。
5、本站一律禁止以任何方式发布或转载任何违法的相关信息，访客发现请向站长举报。
6、本站资源大多存储在云盘，如发现链接失效，请联系我们我们会第一时间更新。
7、本站所有资源来源于互联网，仅用于学习及参考使用，切勿用于商业用途，如产生法律纠纷本站概不负责！ 8、资源除标明原创外均来自网络转载，版权归原作者所有，若侵犯到您权益请联系我们删除，我们将及时处理！ 9、若您需使用非免费的软件或服务，请购买正版授权并合法使用！