软件介绍
Showdoc API文档编辑支持用户从代码文件中自动生成API文档,采用markdown编辑器,是一款在线文档分享工具,还支持从代码自动生成API,它可以加快团队之间沟通的效率。
#下载脚本并赋予权限
#默认安装中文版。如果想安装英文版,请加上en参数,如./showdocen
./showdoc
其他命令:
#执行上面命令便会自动安装完成。下面附上脚本其他命令,以便管理showdoc时可以用得上。
#停止
./showdocstop
#重启
./showdocrestart
#升级showdoc到最新版
./showdocupdate
#卸载showdoc
./showdocuninstall
响应式网页设计,可以将项目文档分享到电脑或移动终端查询。同时还可以将项目导出来成word文档,便于离线浏览。
2、编辑作用
(1)markdown编辑
ShowDoc选用markdown编辑器,不论是编辑或是阅读感受都很好。假如如果你不了解Markdown,请于关键词搜索”认识与新手入门 Markdown”
(2)模板插进
在ShowDoc的编辑网页页面,点一下编辑器上边的按钮可容易地插进API插口模板和数据流图模板。插进模板后,接下来就是修改数据了,省去了很多编辑力气。
(3)历史版本
ShowDoc为网页页面给予历史版本作用,你可以容易地把网页页面恢复正常以前版本。
3、权限设置
(1)公布项目与私秘项目
ShowDoc里的项目有公布项目和私秘项目二种。公布项目能够一切登陆和非登录的页面访问,而私秘项目则需要输入安全校验浏览。登陆密码由项目创建者设定。
(2)项目出让
项目创建者可以自由地把项目出让给网站的别的用户。
(3)项目组员
你可以很方便地为ShowDoc的项目加上、删掉项目组员。项目组员能够对项目开展编辑,但不能转让删除项目(仅有项目创建者才会有管理权限)
(4)团队协作
你可以自行添加好几个精英团队,为队友分派不同类型的项目,同时设置团队中每一个人管理权限。
1、界面简洁友好
2、性能体验优化提升
3、修复了已知bug

Showdoc特色亮点
安装:#下载脚本并赋予权限
#默认安装中文版。如果想安装英文版,请加上en参数,如./showdocen
./showdoc
其他命令:
#执行上面命令便会自动安装完成。下面附上脚本其他命令,以便管理showdoc时可以用得上。
#停止
./showdocstop
#重启
./showdocrestart
#升级showdoc到最新版
./showdocupdate
#卸载showdoc
./showdocuninstall
特色亮点
1、分享与导出来响应式网页设计,可以将项目文档分享到电脑或移动终端查询。同时还可以将项目导出来成word文档,便于离线浏览。
2、编辑作用
(1)markdown编辑
ShowDoc选用markdown编辑器,不论是编辑或是阅读感受都很好。假如如果你不了解Markdown,请于关键词搜索”认识与新手入门 Markdown”
(2)模板插进
在ShowDoc的编辑网页页面,点一下编辑器上边的按钮可容易地插进API插口模板和数据流图模板。插进模板后,接下来就是修改数据了,省去了很多编辑力气。
(3)历史版本
ShowDoc为网页页面给予历史版本作用,你可以容易地把网页页面恢复正常以前版本。
3、权限设置
(1)公布项目与私秘项目
ShowDoc里的项目有公布项目和私秘项目二种。公布项目能够一切登陆和非登录的页面访问,而私秘项目则需要输入安全校验浏览。登陆密码由项目创建者设定。
(2)项目出让
项目创建者可以自由地把项目出让给网站的别的用户。
(3)项目组员
你可以很方便地为ShowDoc的项目加上、删掉项目组员。项目组员能够对项目开展编辑,但不能转让删除项目(仅有项目创建者才会有管理权限)
(4)团队协作
你可以自行添加好几个精英团队,为队友分派不同类型的项目,同时设置团队中每一个人管理权限。
更新说明
v2.4.0版本1、界面简洁友好
2、性能体验优化提升
3、修复了已知bug
相关文章