在线API文档、技术文档工具ShowDoc

Showdoc 是什么？

---

• 可在线编辑 API 文档、技术文档工具；
• 便于开发者对接文档联调，做一些记录；
• 以下是 Docker 下生成运行的 showdoc 实践的记录； 希望能帮助有需要的人；

我在 Centos 7.x 下安装的 docker

# 添加 yum 源
$ yum install epel-release –y
# 清除缓存目录下的软件包
$ yum clean all
# 显示所有的程序包 
$ yum list
# 安装
$ yum install docker-io –y
# 启动
$ systemctl start docker
# 查看信息
$ docker info
复制代码

安装showdoc

1. 从 github 上 clone 代码到本地某个目录
$ git clone -o gitbug https://github.com/star7th/showdoc

2. 进入到showdoc目录开始安装
$ cd showdoc/ 
$ docker build -t showdoc ./
$ docker run -d --name showdoc -p 8080:80 showdoc 如果想在不同端口启动，请修改8080为其它端口

3. 访问ShowDoc
# 在浏览器输入网址 http://xxxx.com:8080/install/

复制代码