showdoc(api文档工具)

system

软件标签:  showdoc   办公软件
showdoc(api文档工具)对于it行业的工作者来说相当实用，通过它能够更加快捷的编写出精美api技术文档，使用方法简单，而且软件内自带多种模板，包括api接口模板、数据字典模板等等，新手如果不熟练的话可以先使用模板来练手。
showdoc电脑版介绍：
showdoc就是一个非常适合it团队的在线文档分享工具，它可以加快团队之间沟通的效率，通过showdoc，你可以方便地使用markdown语法来书写出美观的api文档、数据字典文档、技术文档、在线excel文档等等。



showdoc怎么用？
首先编写api接口的人员需要注册一个账号，便于不同设备的同步管理。

登录成功后，首先展示的是各项目列表，如果未创建过项目，官方也给出了基本实例。

实例文档如下，左侧是目录（支持多级目录），右侧主区域为左侧所选的接口实际内容，默认展示第一条。

一个基础的接口示例，接口文档使用人员需要的时候，只需要将地址栏链接复制即可，不登录的情况下是无法做修改的。
软件功能：
分享与导出

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

markdown编辑

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

历史版本

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

模板插入

在showdoc的编辑页面，点击编辑器上方的按钮可方便地插入api接口模板和数据字典模板。插入模板后，剩下的就是改动数据了，省去了很多编辑的力气。
权限管理：
公开项目与私密项目

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

项目转让

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

团队管理

你可以自行添加多个团队，为团队分配不同的项目，同时设置团队里每个人的权限。

项目成员

你可以很方便地为showdoc的项目添加、删除项目成员。项目成员可以对项目进行编辑，但不可转让或删除项目（只有项目创建者才有权限）
常见问题：
错误提示”general error: 11 database disk image is malformed”？

请确保服务器安装好了php环境和php-sqlite扩展；如果你以ftp方式上传代码到服务器，那么请使用二进制模式上传，否则会损害数据库文件，导致此错误提示。

验证码不显示？

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

提示验证码验证失败？

先到php.ini文件下找找session的保存目录，然后检查安装session目录有没有写入权限，或者可不可能是磁盘空间满了的问题。

怎么进入管理后台？

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

runapi客户端打不开或者一直显示加载中？

runapi需要外网网络。如果在确保已经有了外网网络，可以这样尝试：首先卸载runapi，然后删除以下路径c:usersadministratorappdata
oaming
unapi（其中administrator可替换为你当前登录win系统的账户名），然后再重装runapi。mac环境的用户可以考虑使用appcleaner来卸载和清理数据后再重装。

runapi客户端看不到showdoc的项目？

runapi的数据可以生成markdown格式，但不可逆，markdown数据很难再转换回来runapi。所以它无法跟showdoc原有数据互相转换。只是它们可以共用文档浏览/团队协作等功能。同时runapi生成的文档只能在runapi上编辑，不能在showdoc上编辑。后面如果要做数据共用，可能需要对showdoc编写格式有一定的规范约束，这个后面再探索下。

https://blog.51cto.com/u_16099270/9147646