API文档、技术文档工具

进行项目文档书写以及进行开发。

1.文档阅读

ShowDoc

ShowDoc - demo

安装/升级手册

GitHub - star7th/showdoc: ShowDoc is a tool greatly applicable for an IT team to share documents online一个非常适合IT团队的在线API文档、技术文档工具

自动脚本安装

2.整理输出

2.1 环境部署

因为这里是mac电脑

Docker自动化部署只支持linux环境

所以，这里采用手动安装 php安装的方式。

1. 下载源码

git clone git@github.com:star7th/showdoc.git

2. 进入项目中

cd showdoc

3. 启动Http服务或者放到web服务器的根目录下

这里直接使用php的内置http server启动服务「端口你来定，只不过官方文档上写的是499，也采用了」

php -S sudo php -S localhost:499 -t ./web

4. 浏览器中开始访问

localhost:499

会自行跳转到

http://localhost:499/install/index.php

5.  开始安装登录

这里选择中文

记住管理员的账户密码

showdoc/123456

点击进入首页，点击登录，

输入账号密码，登陆成功

2.2 开始使用

可以新创建项目，也可以导入之前的项目

这里导入已有的项目

上传zip压缩包格式

这里有个坑，上传文件直接http server挂了。

原因：

压缩包文件是36MB，有些大，超过了php的配置参数，

post_max_size = 8M

upload_max_filesize = 2M

解决办法：

临时改下参数值，这里直接改为50M, 之后记得改回来，不过这里是本地开发环境，无所谓了

post_max_size = 50M

upload_max_filesize = 50M

尴尬的是，这个压缩包文件并不是showdoc的压缩包，不过也确实又可能存在上面的问题，遇到就按照上面的办法去解决下。

重新导入上传 showdoc.zip

导入成功

另外，可以直接分享链接给团队成员即可，

不需要注册登陆，有url就可访问，这里是局域网内，自然就是局域网内相同网段的电脑可访问

自己换个浏览器自然也是可以的。

http://localhost:499/web/#/6/31

后续补充

...

TBD