之前和工作室的小伙伴一起完成一个小项目时,都是我在这边写好md文档,然后再用微信发给他,后来又搭了个内网穿透,直接把md文档生成html文件然后放在c盘某个文件夹让小伙伴访问,后来都觉得太麻烦了,接触了showdoc就用上了。。。
ShowDoc是什么
-
word文档零零散散地放在团队不同人那里,需要文档的人基本靠吼,吼一声然后上qq或者邮箱接收对方丢过来的文档。这种沟通方式当然可以,只是效率不高。
-
ShowDoc就是一个非常适合IT团队的在线文档分享工具,它可以加快团队之间沟通的效率。
你可以用它来做什么
- API文档( 查看Demo)
随着移动互联网的发展,BaaS(后端即服务)越来越流行。服务端提供API,APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档。 - 数据字典( 查看Demo)
一份好的数据字典可以很方便地向别人说明你的数据库结构,如各个字段的释义等。 - 说明文档 ( 查看Demo)
你完全可以使用showdoc来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅
安装过程
项目地址:https://github.com/star7th/showdoc
- 首先服务器中创建一个文件夹,并cd到文件夹
mkdir showdoc
cd showdoc
- 然后通过git 安装项目,亦或者可以下载到本地电脑之后scp到目录中
git clone https://github.com/star7th/showdoc.git
- 接着利用项目自带的
Dockerfile
构建镜像
docker build -t --name showdoc ./
- 最后运行镜像 映射端口就好了
docker run -d --name showdoc -p 8080:80 showdoc
- 然后访问 8080端口就可以了,初始管理员账号密码分别是 showdoc 123456
- 设置完之后进入容器中删除掉
install
文件夹,防止别人重新设置
docker exec -it showdoc /bin/bash