showdoc电脑版

showdoc最新版所包含的功能非常多，使用起来也是非常的轻松简单，作为一个深受大家喜爱的api以及技术文档工具，你可以用它来轻松编写各种文档内容等，操作叶寒容易！

showdoc官方版简介

1.ShowDoc是一个非常适合IT团队的在线API文档、技术文档工具。通过showdoc，你可以方便地使用markdown语法来书写出美观的API文档、数据字典文档、技术文档、在线excel文档等等。

2.如果不想编辑markdown文档，你还可以利用showdoc的自动化能力，从程序注释中自动生成API文档，或者从搭配的RunApi客户端（类似postman的api调试工具）中一边调试接口、一边自动生成文档。通过分配项目成员和团队成员，你可以很方便地进行项目文档的权限管理和团队协作，也可以分享文档出去给朋友查看。

软件特点

--数据字典（ 查看Demo）

一份好的数据字典可以很方便地向别人说明你的数据库结构，如各个字段的释义等。

--API文档（ 查看Demo）

随着移动互联网的发展，BaaS（后端即服务）越来越流行。服务端提供API，APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档，同时还将支持从代码文件中自动生成API文档

--说明文档（查看Demo ）

你完全可以使用showdoc来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅。

软件功能简介

--编辑功能

markdown编辑：ShowDoc采用markdown编辑器，无论是编辑还是阅读体验都极佳很棒。如果你不了解Markdown，请在搜索引擎搜索”认识与入门 Markdown”

模板插入：在ShowDoc的编辑页面，点击编辑器上方的按钮可方便地插入API接口模板和数据字典模板。插入模板后，剩下的就是改动数据了，省去了很多编辑的力气。

历史版本：ShowDoc为页面提供历史版本功能，你可以方便地把页面恢复到之前的版本。

--分享与导出

响应式网页设计，可将项目文档分享到电脑或移动设备查看。同时也可以将项目导出成word文件，以便离线浏览。

--权限管理

公开项目与私密项目：ShowDoc上的项目有公开项目和私密项目两种。公开项目可供任何登录与非登录的用户访问，而私密项目则需要输入密码验证访问。密码由项目创建者设置。

项目转让：项目创建者可以自由地把项目转让给网站的其他用户。

项目成员：你可以很方便地为ShowDoc的项目添加、删除项目成员。项目成员可以对项目进行编辑，但不可转让或删除项目（只有项目创建者才有权限）

团队管理：利用showdoc的团队功能你可以更好地进行团队协作

--多平台

showdoc支持网页版、手机app版和电脑客户端版。客户端地址可见：https://www.showdoc.com.cn/clients

--自动化

可从代码注释中自动生成文档

搭配的RunApi客户端，可调试接口和自动生成文档

常见问题说明

忘记了密码怎么办？

如果是使用在线ShowDoc，忘记密码的话可联系xing7th@gmail.com，邮件中说明你的用户名和旗下项目名字（至少提供两个项目）。

如果是自己部署的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 。用此密码登录管理后台即可管理普通用户以及项目。建议登录后修改密码。

若修改密码出错，请确保自己采用最新版代码。

错误提示”General error: 11 database disk image is malformed”

请确保服务器安装好了php环境和php-sqlite扩展；

如果你以FTP方式上传代码到服务器，那么请使用二进制模式上传，否则会损害数据库文件，导致此错误提示

错误提示 “Could not find driver”

请安装php-pdo 和 pdo_sqlite 。

对于Windowns服务器，在php.ini里面把”extension=php_sqlite.dll”和”extension=php_pdo_sqlite.dll”启用以便开启对SQlite的支持；

Linux服务器安装php5.3以上版本时理论上默认是开启了php-pdo和pdo_sqlite的。如果你安装的PHP依然没有，则可搜索网络教程安装之。

私有版showdoc如何连接数据库

showdoc使用sqlite数据库。数据库文件是安装目录下的Sqlite/showdoc.db.php。你可以网络搜索如何在命令行中使用 sqlite数据库.或者使用SQLiteStudio等可视化工具

怎么进入管理后台

新安装完成后，默认管理员账号是showdoc/123456 。使用管理员帐户登录后，在项目列表页面的右上角便能看到管理后台入口。如果不能，请重新登录或者刷新浏览器缓存试试

验证码不显示

请检查是否安装了php-gd库