ShowDoc

一个非常适合IT团队的在线API文档!

回眸只為那壹抹淺笑 提交于 2020-04-18 08:16:07
hello,小伙伴们,大家好,今天给大家推荐这个开源项目 ShowDoc 是非常适合IT团队在线共享文档的工具。一个非常适合IT团队的在线API文档,技术文档工具.感兴趣的小伙伴不妨去看一下。 ShowDoc是什么? 每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂。文档呢?!文档呢?!Show me the doc !! 程序员都很希望别人能写技术文档,而自己却很不希望要写文档。因为写文档需要花大量的时间去处理格式排版,想着新建的word文档放在哪个目录等各种非技术细节。 word文档零零散散地放在团队不同人那里,需要文档的人基本靠吼,吼一声然后上qq或者邮箱接收对方丢过来的文档。这种沟通方式当然可以,只是效率不高。 ShowDoc就是一个非常适合IT团队的在线文档分享工具,它可以加快团队之间沟通的效率。 它可以用来做什么? API文档( 查看Demo ) 随着移动互联网的发展,BaaS(后端即服务)越来越流行。服务端提供API,APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档。 数据字典( 查看Demo ) 一份好的数据字典可以很方便地向别人说明你的数据库结构,如各个字段的释义等。 说明文档( 查看Demo ) 你完全可以使用showdoc来编写一些工具的说明书

离线环境玩Docker-镜像篇

风流意气都作罢 提交于 2019-11-30 03:34:23
接上一篇。之前联网环境的Docker已经安装成功了,那么一切都好办,思路就是把Docker镜像保存为文件,然后放到不能联网的电脑上面,导入镜像即可。 第一步:导出Docker镜像,这里以showdoc为例,这是showdoc的官方文档地址: https://www.showdoc.cc/help?page_id=65610 #将镜像pull到本地 docker pull star7th/showdoc #保存镜像到当前目录的show.tar目录 docker save -o show.tar star7th/showdoc 第二步:导入Docker镜像,用这台联网的测试一下把,看看是否能够正常运行。 #删除刚才通过pull下载的镜像 docker rmi star7th/showdoc #为了更好的测试,先断网吧,虽然断网也没影响,开始导入镜像 docker load -i show.tar 第三步:运行我们刚才导入的镜像,先参照官网做一些准备。 #准备工作 sudo mkdir /showdoc_data sudo mkdir /showdoc_data/html sudo chmod -R 777 /showdoc_data #开始运行 docker run -d --name showdoc -p 4999:80 -v /showdoc_data/html:/var/www