php适合IT团队的在线文档分享工具,可加快团队之间沟通的效率
php适合IT团队的在线文档分享工具,可加快团队之间沟通的效率 一、项目简介 一个非常适合IT团队的在线API文档、技术文档工具。通过showdoc,你可以方便地使用markdown语法来书写出美观的API文档、数据字典文档、技术文档、在线excel文档等等。如果不想编辑markdown文档,你还可以利用showdoc的自动化能力,从程序注释中自动生成API文档,或者从搭配的RunApi客户端(类似postman的api调试工具)中一边调试接口、一边自动生成文档。通过分配项目成员和团队成员,你可以很方便地进行项目文档的权限管理和团队协作,也可以分享文档出去给朋友查看。ShowDoc还支持多平台客户端,有win客户端、mac客户端、ios、android等,更方便跨平台使用。目前超过100000+的互联网团队正在使用showdoc,包括知名公司内部的一些团队,比如腾讯、华为、百度、京东、字节跳动等等。
二、功能概述它可以用来做什么
它都有些什么功能
三、技术选型技术栈说明 前端:Vue + ElementUI
后端:为了兼容低版本的php运行环境(兼容至5.3),使用的是保守的ThinkPHP3.2.3框架
数据库:showdoc自带文件型数据库(/Sqlite/showdoc.db.php),不需要用户手动安装数据库
开发前准备 开发机器需要先安装好PHP环境和NodeJS环境
下载代码并放置到PHP环境下的www目录
先在浏览器通过地址访问,以便完成showdoc的初始化安装(如已安装过则忽略)
在命令行里进入showdoc的web_src目录,执行npm install 以安装依赖。(若无npm,你则先要安装NodeJS环境)
前端开发 执行npm run dev 以启用调式模式,通过访问 localhost:8080 便可以实时看到改动的效果。请使用代理以便请求后端API的时候代理到PHP服务端。设置代理可以用自己顺手的代理工具,或者参考 这里
需要执行npm run build 才会最终打包生效。打包后的静态文件会在/web目录下
主要涉及到的目录和文件:
复制代码 后端开发 主要涉及到的目录和文件
复制代码 其它说明 二次开发后请尊重开源项目,保留版权标识和链接
如开发了好用的功能,不妨贡献到官方github代码仓库以分享给大家用
showdoc往后升级可能会覆盖你原有的二次开发。如果想兼容,最好提交到官方仓库成为官方功能。
|
下载说明:
1.本站资源都是白菜价出售,同样的东西,我们不卖几百,也不卖几十,甚至才卖几块钱,一个永久会员能下载全站100%源码了,所以单独购买也好,会员也好均不提供相关技术服务。
2.如果源码下载地址失效请联系站长QQ进行补发。
3.本站所有资源仅用于学习及研究使用,请必须在24小时内删除所下载资源,切勿用于商业用途,否则由此引发的法律纠纷及连带责任本站和发布者概不承担。资源除标明原创外均来自网络整理,版权归原作者或本站特约原创作者所有,如侵犯到您权益请联系本站删除!
4.本站站内提供的所有可下载资源(软件等等)本站保证未做任何负面改动(不包含修复bug和完善功能等正面优化或二次开发);但本网站不能保证资源的准确性、安全性和完整性,由于源码具有复制性,一经售出,概不退换。用户下载后自行斟酌,我们以交流学习为目的,并不是所有的源码都100%无错或无bug;同时本站用户必须明白,【188资源网】对提供下载的软件等不拥有任何权利(本站原创和特约原创作者除外),其版权归该资源的合法拥有者所有。
5.请您认真阅读上述内容,购买即以为着您同意上述内容。
188资源网 » php适合IT团队的在线文档分享工具,可加快团队之间沟通的效率
1.本站资源都是白菜价出售,同样的东西,我们不卖几百,也不卖几十,甚至才卖几块钱,一个永久会员能下载全站100%源码了,所以单独购买也好,会员也好均不提供相关技术服务。
2.如果源码下载地址失效请联系站长QQ进行补发。
3.本站所有资源仅用于学习及研究使用,请必须在24小时内删除所下载资源,切勿用于商业用途,否则由此引发的法律纠纷及连带责任本站和发布者概不承担。资源除标明原创外均来自网络整理,版权归原作者或本站特约原创作者所有,如侵犯到您权益请联系本站删除!
4.本站站内提供的所有可下载资源(软件等等)本站保证未做任何负面改动(不包含修复bug和完善功能等正面优化或二次开发);但本网站不能保证资源的准确性、安全性和完整性,由于源码具有复制性,一经售出,概不退换。用户下载后自行斟酌,我们以交流学习为目的,并不是所有的源码都100%无错或无bug;同时本站用户必须明白,【188资源网】对提供下载的软件等不拥有任何权利(本站原创和特约原创作者除外),其版权归该资源的合法拥有者所有。
5.请您认真阅读上述内容,购买即以为着您同意上述内容。
188资源网 » php适合IT团队的在线文档分享工具,可加快团队之间沟通的效率