帮助说明

ShowDoc是什么

ShowDoc是一个非常适合IT团队的在线API文档、技术文档工具。通过showdoc，你可以方便地使用markdown语法来书写出美观的API文档、数据字典文档、技术文档、在线excel文档等等。如果不想编辑markdown文档，你还可以利用showdoc的自动化能力，从程序注释中自动生成API文档，或者从搭配的RunApi客户端（类似postman的api调试工具）中一边调试接口、一边自动生成文档。通过分配项目成员和团队成员，你可以很方便地进行项目文档的权限管理和团队协作，也可以分享文档出去给朋友查看。ShowDoc还支持多平台客户端，有win客户端、mac客户端、ios、android等，更方便跨平台使用。目前超过100000+的互联网团队正在使用showdoc，包括知名公司内部的一些团队，比如腾讯、华为、百度、京东、字节跳动、顺丰等等。

强烈推荐配套runapi使用，接口直接生成文档：RunApi

它可以用来做什么

• API文档（ 查看demo）
  • 随着移动互联网的发展，BaaS（后端即服务）越来越流行。服务端提供API，APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档。
• 数据字典（ 查看Demo）
  • 一份好的数据字典可以很方便地向别人说明你的数据库结构，如各个字段的释义等。

说明文档 （查看Demo）

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

它都有些什么功能

分享与导出

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

权限管理

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

  项目转让

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

  项目成员

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

  团队管理

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

编辑功能

• markdown编辑

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

• 模板插入

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

• 历史版本

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

多平台

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

自动化

• 可从代码注释中自动生成文档
• 搭配的RunApi客户端，可调试接口和自动生成文档
• 使用在线的ShowDoc
• 如果你没有自己的服务器，但又想使用ShowDoc作为文档分享工具，你可以使用在线的ShowDoc http://www.showdoc.com.cn
• 在线showdoc作为在线服务会长期维护，请放心托管数据

部署到自己的服务器

• ShowDoc部署手册请参考：https://www.showdoc.cc/help?page_id=13732

开源地址：https://github.com/star7th/showdoc （国内镜像 https://gitee.com/star7th/showdoc ）。若觉得showdoc好用，不妨点个star。良好的关注度和参与度有助于开源项目的长远发展。

二次开发指引

https://www.showdoc.com.cn/help?page_id=1385576954326448