HomeLab迷你小主机（x86）：Docker部署开源文档ShowDoc[API文档,技术文档]

NO.1

ShowDoc简介

github地址

https://github.com/star7th/showdoc

docker images地址

https://hub.docker.com/r/star7th/showdoc

适合IT团队的在线API文档、技术文档工具

ShowDoc本来打算是第一个选择的开源文档服务

优点有很多

开源免费,可以docker自部署
可以一键复制粘贴图片,支持mrakdown
支持项目加密,支持文档分享
支持API文档,也支持技术文档
可以创建多级目录(如三级菜单)(wiki.js就不行,因为这个就弃用wiki.js)

不推荐的地方

UI实在不方便吐槽,既没有GitBook的简洁大气,也没有WikiJs的现代风格
文档会自动被搜索引擎收录,没有单独设置不被收录的选项(很久以前的内容,找不到原帖)(有些文档设置域名,但并不意味着想要被搜索引擎收录,但是showdoc默认允许收录)

所以文档能加密就优先加密

NO.2

ShowDoc安装

几年前写的ShowDoc安装

<<docker安装协作文档showDoc>>

新建docker-compose.yml文档

version: '3.1'
services:
  showdoc:
    image: star7th/showdoc:latest
    restart: always
    ports:
      - 7027:80
    volumes:
      - ./html:/var/www/html/

开放端口

sudo ufw allow 7027

拉取镜像并启动服务

docker-compose up

看到表格说明启动成功

NO.3

ShowDoc使用

访问ip和端口

选择中文或者英文

初始化成功。

默认管理员账户密码是showdoc/123456。

登录后，在右上角可以看到管理后台入口。

点击进入首页

首页界面

点击登录

输入默认账户和密码

进入文档页面

剩下慢慢使用即可

NO.4

Tips

PS:

截止到目前,已经搭建了6种开源文档应用(笔记或者Wiki)

打算使用自部署的为知笔记

但是在分享的时候看到弹框提示,公开内容需要审核(具体是否审核和怎么审核未知)

访问文档后,有两个不太好的地方

一个是明显的为知笔记标识以及笔记标语(不喜欢)

一个是控制台可以看到谷歌分析的上报

也就是这种半开源的产品,虽然方便,但是限制账户,设置标识,同时一旦联网就可能进行扫盘或者上报数据之类的操作,使用时还是得酌情考虑

点击购买许可,提示服务不可用

也就是上次说的,不论是公众号还是邮箱还是官网论坛联系客服都联系不上

付费也没有人响应,后续的笔记服务能维持多久,值得商榷

转了一圈又回到ShowDoc

END.

觉得本文还行，不妨顺手点赞和收藏，下期见。