一键搭建私有文档库!Docker神器Docat实战指南

一键搭建私有文档库!Docker神器Docat实战指南

兄弟们,最近团队要搞API文档管理,测试妹子天天追着我要接口说明,产品经理又总改需求文档版本。今天二冰掏出一个Docker神器,5分钟搭建版本化文档托管平台,支持PDF/HTML/Word在线预览,GitHub已斩获1.4k星!

项目速览

Docat(GitHub地址:github.com/docat-org/do)专为开发者打造的轻量级文档托管方案:

  • • 支持多版本文档并行管理
  • • 完美兼容MkDocs/Sphinx生成文档
  • • 网页端/Cli工具双通道上传
  • • 一条Docker命令秒级部署

三大核心优势

1. 版本控制黑科技

版本管理界面(图片地址:img.twoice.fun:666/i/20)开发文档从v1.0到v3.2-beta随意切换,再也不用手动改文件名了!

2. 格式通吃

  • • HTML在线渲染
  • • PDF/Word/Excel在线预览
  • • Markdown自动解析

3. 零基础部署

用Dockge可视化部署,小白也能玩转:

手把手部署教程

Step1. 创建compose文件

version: "3"

services:
  docat:
    image: ghcr.io/docat-org/docat:latest
    container_name: docat
    restart: unless-stopped
    ports:
      - "5066:80"
    volumes:
      - ./doc:/var/docat/

Step2. Dockge可视化部署

打开Dockge面板 -> 创建堆栈 -> 设置堆栈名称 -> 粘贴compose代码 -> 30秒启动成功!

实战操作指南

文档上传三连击

  1. 1. 点击左下角「Upload」按钮
  2. 2. 填写项目名+版本号
  3. 3. 拖拽压缩包(支持zip/tar.gz)

版本切换骚操作

# 命令行标记最新版本
docatl tag --host http://你的IP:5066 项目名 v2.3.1 latest

在线预览神器

文档地址自动生成:

http://服务器IP:5066/项目名/版本号/文件名.pdf

避坑指南

⚠️ 压缩包不要带目录层级
⚠️ 必须包含index.html作为入口⚠️ PDF文件建议小于50MB

总结推荐

经过一周实测,Docat完美hold住:
✅ 10人以内技术团队文档协作
✅ 开源项目版本化说明文档✅ 个人技术博客归档

适合人群

  • • 不想用Confluence的小团队
  • • 需要展示多版本文档的开源作者
  • • 喜欢折腾Docker的极客玩家

文档展示效果

兄弟们如果遇到部署问题,欢迎在评论区开怼!觉得有用的话记得点赞收藏~

最后,奉上我的超级无敌至尊docker库,二冰平时玩过的docker都整理到了这个仓库中了,一直在更新中,希望有github账号的兄弟能去给点个star,不知道玩啥的,都去这里面找,都给你们分好类了
仓库链接:github.com/TWO-ICE/Awes