ShowDoc是什么
ShowDoc是一个非常适合IT团队的在线API文档、技术文档工具。通过showdoc,你可以方便地使用markdown语法来书写出美观的API文档、数据字典文档、技术文档、在线excel文档等等。如果不想编辑markdown文档,你还可以利用showdoc的自动化能力,从程序注释中自动生成API文档,或者从搭配的RunApi客户端(类似postman的api调试工具)中一边调试接口、一边自动生成文档。通过分配项目成员和团队成员,你可以很方便地进行项目文档的权限管理和团队协作,也可以分享文档出去给朋友查看。ShowDoc还支持多平台客户端,有win客户端、mac客户端、ios、android等,更方便跨平台使用。目前超过100000+的互联网团队正在使用showdoc,包括知名公司内部的一些团队,比如腾讯、华为、百度、京东、字节跳动、顺丰等等。
它可以用来做什么
API文档
随着移动互联网的发展,BaaS(后端即服务)越来越流行。服务端提供API,APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档。
数据字典( 查看Demo)
一份好的数据字典可以很方便地向别人说明你的数据库结构,如各个字段的释义等。
说明文档 ( 查看Demo)
你完全可以使用showdoc来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅
它都有些什么功能
分享与导出
响应式网页设计,可将项目文档分享到电脑或移动设备查看。同时也可以将项目导出成word文件,以便离线浏览。
权限管理
公开项目与私密项目
ShowDoc上的项目有公开项目和私密项目两种。公开项目可供任何登录与非登录的用户访问,而私密项目则需要输入密码验证访问。密码由项目创建者设置
项目转让
项目创建者可以自由地把项目转让给网站的其他用户。
项目成员
你可以很方便地为ShowDoc的项目添加、删除项目成员。项目成员可以对项目进行编辑,但不可转让或删除项目(只有项目创建者才有权限)
团队管理
利用showdoc的团队功能你可以更好地进行团队协作
编辑功能
markdown编辑
ShowDoc采用markdown编辑器,无论是编辑还是阅读体验都极佳很棒。如果你不了解Markdown,请在搜索引擎搜索”认识与入门 Markdown”
模板插入
在ShowDoc的编辑页面,点击编辑器上方的按钮可方便地插入API接口模板和数据字典模板。插入模板后,剩下的就是改动数据了,省去了很多编辑的力气。
历史版本
ShowDoc为页面提供历史版本功能,你可以方便地把页面恢复到之前的版本。
多平台
showdoc支持网页版、手机app版和电脑客户端版。客户端地址可见:点此查看
自动化
可从代码注释中自动生成文档
搭配的RunApi客户端,可调试接口和自动生成文档
部署到自己的服务器
ShowDoc部署手册请参考:点击打开
开源地址:点此跳转 (国内镜像 点此跳转 )。若觉得showdoc好用,不妨点个star。良好的关注度和参与度有助于开源项目的长远发展。
二次开发指引
点此查看
更新日志
v3.4.1
项目列表支持卡片视图
增加微信推送提醒功能
分享的单页链接支持有效期设置
搜索的时候显示页面路径
编辑器增加插入PlantUML功能
修复导入文件的bug
v3.3.1
修复一些已知的bug
v3.3.0
可设置全站项目要求登录后方可访问
上传图片附件到oss的时候支持设置子目录
更换了一个更好看的图片预览插件
优化编辑交互体验
修复导入json文件的bug
修复程序注释生成API文档的bug
修复水印生成时候不能全屏的bug
v3.2.5 和 v3.2.6
修复了一些安全问题
v3.2.3
常规更新,修复一些已知的bug
版本v3.2.0 、 v3.2.1 和 v3.2.2
此版本主要是优化视觉UI和交互体验。
文档目录数支持拖曳排序和右键菜单操作,可以快速添加页面以及子文件等
优化移动端访问项目的效果
更换了更好看的产品图标
优化小屏设备的访问效果
将大多有跟 页面 有关的操作移动到文档目录树底部操作栏
其它小细节
版本v3.1.0
增加AI助手功能,辅助生成文档。showdoc官网默认开启,私有版showdoc则需要管理员在后台开启。
版本v3.0.0 、 v3.0.1 和 v3.0.3
重写了UI和交互逻辑,大大提升了视觉效果和操作体验,包括但不限于以下内容:
展示多个项目时候采用列表结构,同时完善项目分组功能,适合更多项目的场景
大部分打开新页面的操作,如用户中心、目录管理、团队管理等等,都改为当前页面弹窗的形式,方便关闭弹窗后无感回到之前的操作,避免割裂感。
完善拖放组件,涉及到拖放的场景,比如项目分组的拖放、页面排序的拖放、目录管理的拖放,都统一元素高度和样式。
调整项目展示页的布局,包括常规多页项目、单页项目和表格展示项目,增加统一的header和图标样式。
调整功能按钮的展示与收起逻辑,在便捷和简洁间取得平衡。
修复一些累积的bug
帮助页面
点此以了解相关内容