ShowDoc介绍 ShowDoc就是一个非常适合IT团队的在线文档分享工具,它可以加快团队之间沟通的效率. API文档( 查看Demo) 随着移动互联网的发展,BaaS(后端即服务)越来越流行.服务端提供API,APP端或者网页前端便可方便调用数据.用ShowDoc可以非常方便快速地编写出美观的API文档. 数据字典( 查看Demo) 一份好的数据字典可以很方便地向别人说明你的数据库结构,如各个字段的释义等. 说明文档(查看Demo ) 你完全可以使用showdoc来编写一些工具的说明书,也可…

JAVA学习总结    2 第一天    2 1:计算机概述(了解)    2 (1)计算机    2 (2)计算机硬件    2 (3)计算机软件    2 (4)软件开发(理解)    2 (5)语言    2 (6)人机交换    2 2:键盘功能键的认识和快捷键(掌握)    2 (1)功能键的认识    2 (2)快捷键    3 3:常见的DOS命令(掌握)    3 (1)常见的如下    3 (2)其他的几个(了解)    3 4:Java语言概述(了解)    4 (1)Jav…

========================== showdoc 简介==========================在线文档管理系统很多, 比如阿里的语雀.腾讯的 TAPD 平台也包括文档管理功能, 但这些系统需要联网的, 企业内文档协作工具不是很多, 最有名的是收费的 confluence 了, 禅道有文档管理功能, 但功能较弱, 比较适合附件上传管理. 这里介绍 Showdoc 这款开源(免费)文档管理系统, 可以部署企业内部, 后台使用 php + sqlite, 支持 Wind…

在Docker中部署ShowDoc 一.安装Docker 1.安装Docker yum install docker 最后出现Complete即可 2.启动服务 # service docker start 3.设置为开机启动 # chkconfig docker on windows环境官网下载地址 二.安装git # yum install git 最后出现Complete即可 三.安装ShowDoc项目 首先下载docker文件项目,然后build建立静态镜像文件(类似于Vmware的快照…

目录 CentOS7中部署Showdoc 前置环境 部署 配置文件 解压安装包 添加启动服务 设置权限 运行安装 界面 CentOS7中部署Showdoc 文:铁乐与猫 前置环境 因为showdoc其实就是可以认为是一个php网站,所以从GitHub上下载整个代码包回来部署在服务器的网站目录上就好了. 但前提是你php和网站环境要先搭建好. 这里实操我使用的是比较熟悉的nginx+PHP 系统是CentOS7.2 64位 nginx已编译安装好 php环境通过yum安装一下,会比较好解决依赖关系…

:WPA;P:hejia,888?;S:Hejia666; https://github.com/qq1415551519 HTML+CSS·经常使用的设计方法: ======================================================https://github.com/getlantern/download // empty() 判断遍历是不是空, 为空:[真]bool(true).不为空:[假]bool(false)// 真:0 0.00 '' '0'…

介绍 showdoc是一个适合IT团队的文档工具,阅读本文前需要对showdoc有基本了解 .基本介绍可看:https://www.showdoc.cc/help 对于写API文档这件事,虽然说文本编辑软件或者接口管理软件能在某种程度上提高我们的效率,但我们依然可以试图借助技术的力量,更自动化地生成API文档,释放自己的生产力.为此,showdoc官方提供了一种自动化解决方案.在代码里编写特定格式的程序注释,然后showdoc通过读取这些注释来自动生成文档.由于这种方式不跟特定的语言耦合,因此它…

最近在做新项目,感觉写完一个接口 还要去再写一遍api文档 挺浪费时间的,所以借用ShowDoc的api开放功能 自动生成api文档. 首先 去 https://www.showdoc.cc/ 注册一个账户,新建一个项目, 建立新项目后,选择该项目,打开,进入项目界面 然后点击项目,下拉选择项目设置, 可以看到开放API,下面还有Api文档,数据字典文档 Windows系统安装步骤: 自动化生成API文档,首先需要下载Git ,推荐下载地址: https://npm.taobao.org/mir…

自动脚本安装 前言 自动脚本脚本利用docker来安装运行环境,适用于linux服务器.如果你的服务器没有docker服务,脚本会尝试安装之.安装docker的过程可能有些慢.如果你已经安装过docker,脚本会省略部分步骤,从而加快showdoc安装进度. 当脚本安装docker失败时,你可以手动安装好docker后再执行脚本 .若装好了docker后还是再失败,则可根据此教程一步步地安装和调试: https://www.showdoc.cc/help?page_id=65610 如果服务器系…

我目前每天主要工作以开发api为主,这都离不开接口文档.如果远程对接的话前端总说Swagger不清晰,只能重新找一下新的接口文档.ShowDoc就是一个不错的选择,简洁.大方.灵活部署. 但是话说回来,既然是文档每个接口你都得写.总感觉这样效率太慢了,能不能自己生成一下,自己只要Ctrl+C.Ctrl+V就万事大吉了. 早就想写一下,今天抽空做了一下(后期我会继续完善,时间.精力有限).提前说好,我只写了一个查询的.而且也不可能说是生成了就不用改了,里面的文本信息全都符合各位同学的预期.但至少百…