轻松搭建 IT 团队专属 API 与技术文档库，NAS 部署 ShowDoc 教程

NasBox

ShowDoc：

一个非常适合 IT 团队的在线 API 文档、技术文档工具。通过 showdoc ，你可以方便地使用 markdown 语法来书写出美观的 API 文档、数据字典文档、技术文档、在线 excel 文档等等。

在线预览：

https://www.showdoc.com.cn/demo

安装

Docker Compose

services:
  showdoc:
    image: star7th/showdoc:latest
    container_name: showdoc
    ports:
      - 4999:80
    volumes:
      - ./html:/var/www/html
    restart: always

使用

浏览器中输入 http://NAS的IP:4999 就能看到界面

选择语言

初始化完成，点击进入首页

TIP：客户端支持情况

右上角点击登录

输入默认用户名和密码（showdoc/123456）进行登录

界面看起来还行，挺简洁的

TIP：下面简单看看默认模板示例

API文档示例

数据字典示例

技术团队文档示例

表格示例

白板项目示例

TIP：功能比较多，这里就简单演示一下

点击底部可以创建新项目，也可以选择模板进行创建

这里我就直接创建一个了

当前项目是空白的，点击创建页面

从模板加入，可以比较方便套用相同格式

格式工具，支持各种格式转为表格类型

文档工具，支持历史版本

保存页面后，右上角可以分享页面地址

更多，支持导入和导出文档

文件库，存放文件和图片

团队管理，简单的分发项目给各个团队

管理后台，功能都比较简单

总结

对于普通用户而言，ShowDoc 的实用性不大，主要是针对 IT 团队用于快速生成 API 文档与技术文档。它支持通过 Markdown 语法来撰写各类文档，涵盖 API 文档、数据字典、技术文档等多种类型，能满足团队在技术文档创作与管理上的需求。

综合推荐：⭐⭐（适合 IT 团队搭建 API 文档与技术文档）

使用体验：⭐⭐⭐（轻量化，易上手）

部署难易：⭐⭐（简单）︎