showdoc手机版为用户提供了专业的api文档编辑功能,大家下载软件之后首先需要注册账号,按照要求填写完账号、密码、验证码即可,登录之后就能体验便捷的文档在线编辑服务,支持团队成员之间共享文档,并且可以保留编辑历史,有助于提升整体办公效率。
showdoc官方介绍:
showdoc是一个非常适合IT团队的在线API文档、技术文档工具。通过showdoc,你可以方便地使用markdown语法来书写出美观的API文档、数据字典文档、技术文档、在线excel文档等等。如果不想编辑markdown文档,你还可以利用showdoc的自动化能力,从程序注释中自动生成API文档,或者从搭配的RunApi客户端(类似postman的api调试工具)中一边调试接口、一边自动生成文档。通过分配项目成员和团队成员,你可以很方便地进行项目文档的权限管理和团队协作,也可以分享文档出去给朋友查看。ShowDoc还支持多平台客户端,有win客户端、mac客户端、ios、android等,更方便跨平台使用。目前超过100000+的互联网团队正在使用showdoc,包括知名公司内部的一些团队,比如腾讯、华为、百度、京东、字节跳动等等。
showdoc使用手册:
API文档
APP、web前端与服务器常用API来进行交互。
用ShowDoc可以方便快速编写出美观的API文档。
数据字典
好的数据字典可以很方便地向别人描述你的数据库结构。
用ShowDoc可以编辑出美观的数据字典。
说明文档
你完全可以使用 ShowDoc来编写一些工具的说明书。
也可以编写一些技术规范说明文档以供团队查阅。
团队协作
团队权限管理机制让团队良好地协同编写文档。
文档自动化
可从代码注释中自动生成文档。
搭配的RunApi客户端,可调试接口和自动生成文档。
免费开源
ShowDoc提供免费开源的版本。
你可以选择将ShowDoc部署到你的服务器。
在线托管
www.showdoc.com.cn 安全稳定的在线文档托管服务。
你可以放心地选择托管你的文档数据在云端。
软件说明:
1、ShowDoc上的项目有公开项目和私密项目两种。
2、公开项目可供任何登录与非登录的用户访问。
3、私密项目则需要输入密码验证访问,密码由项目创建者设置。
4、你可以很方便地为ShowDoc的项目添加、删除项目成员。
5、项目成员可以对项目进行编辑,但不可转让或删除项目。
6、点击编辑器上方的按钮可方便地插入API接口模板和数据字典模板。
7、插入模板后,剩下的就是改动数据了,省去了很多编辑的力气。
8、项目创建者可以自由地把项目转让给网站的其他用户。
9、利用showdoc的团队功能你可以更好地进行团队协作。
常见问题:
忘记了密码怎么办?
如果是自己部署的ShowDoc,则首先根据前面安装文档进行升级,确保使用最新代码(划重点)。
然后,根据安装方式的不同有不同的密码重置方式。
如果是使用官方脚本或者docker方式安装的,请在命令行执行命令:
docker exec showdoc bash -c "cd /var/www/html/ && php ./index.php home/common/repasswd"
如果是手动安装php方式的,则在命令行中切换到showdoc安装目录然后执行:
php index.php home/common/repasswd
以上命令会把管理员showdoc的密码重置为123456 。用此密码登录管理后台即可管理普通用户以及项目。建议登录后修改密码。
若修改密码出错,请确保自己采用最新版代码。
私有版showdoc如何连接数据库?
showdoc使用sqlite数据库,数据库文件是安装目录下的Sqlite/showdoc.db.php。
你可以网络搜索如何在命令行中使用 sqlite数据库.或者使用SQLiteStudio等可视化工具。