自建ShowDoc，个人文档管理工具

简介

ShowDoc是一款开源的在线API文档管理工具，它提供了一个简单而强大的平台，用于团队协作编写和维护API文档。ShowDoc的设计理念是简单易用，它提供了直观的界面和丰富的功能，使得编写和查看API文档变得更加高效和便捷。

安装环境

  • 宝塔面板
  • 一台Linux服务器
  • SSL域名

部署

  1. 宝塔安装
  2. Docker安装
  3. 在对应目录新建docker-compose.yml文件，文件如下
1
2
3
4
5
6
7
8
version: '3'
services:
  showdoc:
    image: star7th/showdoc:latest
    ports:
      - 4999:80
    volumes:
      - /www/wwwroot/showdoc/html:/var/www/html/
  1. 使用docker-compose方式拉取镜像并运行
1
docker-compose up -d

  1. 使用Nginx进行域名映射和反向代理（映射方式和反向代理方法可在博客内搜索Nginx查看，自己对应替换域名、端口、证书）
  2. 首次访问域名，进行初始化(以下图片为本地演示，仅用做展示)

应用

  1. 文档编辑，支持Markdown
  2. 页面分享
  3. 历史记录

  4. 在线测试
  5. 用户管理
  6. 站点设置

总结

ShowDoc提供了丰富的功能和特性，使得编写和管理API文档变得更加简单和高效。以下是一些ShowDoc的主要应用场景：

  1. API文档管理：ShowDoc提供了一个直观的界面，可以方便地编写和维护API文档。你可以创建项目和页面，添加接口和参数说明，支持Markdown语法，使得文档编写更加灵活和易读。
  2. 团队协作：ShowDoc支持多人协作编辑，团队成员可以同时编辑同一个文档，实时查看和更新文档内容。通过权限管理，你可以控制团队成员的访问和编辑权限，确保文档的安全性和一致性。
  3. 接口测试：ShowDoc内置了接口测试功能，你可以在文档中直接调用接口并查看返回结果。这使得接口测试更加便捷，同时也方便了开发人员对接口的理解和调试。
  4. 文档导出和分享：ShowDoc支持将文档导出为HTML或Markdown格式，方便与他人分享或发布到其他平台。你可以将文档作为静态文件部署到任何Web服务器上，或者将其集成到其他系统中。

作为一款开源的文档工具，功能丰富，见面设计友好，推荐大家部署使用🤞🏻