showdoc 功能
1、编辑功能
(1)markdown编辑
ShowDoc采用markdown编辑器,无论是编辑还是阅读体验都极佳很棒。如果你不了解Markdown,请在搜索引擎搜索”认识与入门 Markdown”
(2)模板插入
在ShowDoc的编辑页面,点击编辑器上方的按钮可方便地插入API接口模板和数据字典模板。插入模板后,剩下的就是改动数据了,省去了很多编辑的力气。
(3)历史版本
ShowDoc为页面提供历史版本功能,你可以方便地把页面恢复到之前的版本。
2、分享与导出响应式网页设计,可将项目文档分享到电脑或移动设备查看。同时也可以将项目导出成word文件,以便离线浏览。
3、权限管理
(1)公开项目与私密项目
ShowDoc上的项目有公开项目和私密项目两种。公开项目可供任何登录与非登录的用户访问,而私密项目则需要输入密码验证访问。密码由项目创建者设置。
(2)项目转让
项目创建者可以自由地把项目转让给网站的其他用户。
(3)项目成员
你可以很方便地为ShowDoc的项目添加、删除项目成员。项目成员可以对项目进行编辑,但不可转让或删除项目(只有项目创建者才有权限)
(4)团队管理
你可以自行添加多个团队,为团队分配不同的项目,同时设置团队里每个人的权限。
showdoc特点
1、API文档
伴随着移动互联的发展趋势,BaaS(后端开发即服务项目)愈来愈流行。服务器端出示API,APP端或是网页页面前端开发便可便捷启用数据信息。用ShowDoc能够 十分便捷迅速地编写出美观大方的API文档,另外还将适用从编码文档中自动生成API文档
2、数据字典
一份好的数据字典能够 很便捷地为他人表明你的数据库查询构造,如每个字段名的释意等。
3、表明文档
你彻底能够 应用showdoc来编写一些专用工具的使用说明,还可以编写一些技术标准表明文档以供精英团队查看。
以上便是winwin7小编给大家介绍的API文档编辑工具showdoc!