ShowDoc采用最新的Markdown编辑器打造的强大的aip文档编写软件,用来帮助用户轻松快速编写出api文档。ShowDoc非常适合在线文档分享,以提高团队之间的沟通效率,用户一般借助Markdown语法书写api文档、数据字典文件、技术文档等等文件。
软件功能
1、分享与导出
响应式网页设计,可将项目文档分享到电脑或移动设备查看。同时也可以将项目导出成word文件,以便离线浏览。
2、编辑功能
(1)markdown编辑
ShowDoc采用markdown编辑器,无论是编辑还是阅读体验都极佳很棒。如果你不了解Markdown,请在搜索引擎搜索”认识与入门 Markdown”
(2)模板插入
在ShowDoc的编辑页面,点击编辑器上方的按钮可方便地插入API接口模板和数据字典模板。插入模板后,剩下的就是改动数据了,省去了很多编辑的力气。
(3)历史版本
ShowDoc为页面提供历史版本功能,你可以方便地把页面恢复到之前的版本。
3、权限管理
(1)公开项目与私密项目
ShowDoc上的项目有公开项目和私密项目两种。公开项目可供任何登录与非登录的用户访问,而私密项目则需要输入密码验证访问。密码由项目创建者设置。
(2)项目转让
项目创建者可以自由地把项目转让给网站的其他用户。
(3)项目成员
你可以很方便地为ShowDoc的项目添加、删除项目成员。项目成员可以对项目进行编辑,但不可转让或删除项目(只有项目创建者才有权限)
(4)团队管理
你可以自行添加多个团队,为团队分配不同的项目,同时设置团队里每个人的权限。
软件功能
1、API文档
随着移动互联网的发展,BaaS(后端即服务)越来越流行。服务端提供API,APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档,同时还将支持从代码文件中自动生成API文档
2、数据字典
一份好的数据字典可以很方便地向别人说明你的数据库结构,如各个字段的释义等。
3、说明文档
你完全可以使用showdoc来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅。
ShowDoc使用方法
安装:
#下载脚本并赋予权限
wget https://www.showdoc.cc/script/showdoc;ch mod +x showdoc;
#默认安装中文版。如果想安装英文版,请加上en参数,如 。/showdoc en
./showdoc
其他命令:
#执行上面命令便会自动安装完成。下面附上脚本其他命令,以便管理showdoc时可以用得上。
#停止
./showdoc stop
#重启
./showdoc restart
#升级showdoc到最新版
./showdoc update
#卸载showdoc
./showdoc uninstall
多多直播电脑版为主播提供了便捷的拼多多直播带货工具,商家可借此推广商品,提升店铺流量,而达人则能协助商家带货,获取佣金。多多直播电脑版有助于增强客户粘性,提高流量转化效率,支持商品...
央视影音是一款集新闻、综艺、体育、少儿等多类型节目于一体的视频播放软件,它不仅提供丰富的国内央视节目,还涵盖众多地方卫视和特色频道的精彩内容,用户喜欢看什么,一键搜索即可。央视影音...
浩辰CAD 2025是一款功能多样的CAD设计软件,终端数据和模型上云互通,打造全新的云端协同办公体验。该软件在参数化约束技术上取得了显著突破,为企业国产化应用提供了坚实有力的支持。同时,它...
Visual Studio Code是一款操作便捷的代码编辑器,具备强大扩展性,用户可通过丰富的插件库,轻松打造个性化的工作环境。它能够兼容多种编程语言,内置智能代码补全、语法高亮、代码折叠等多项功...
Audacity是一款功能多样的跨平台音频编辑软件,拥有剪切、复制、粘贴、淡入淡出等实用音频编辑工具,还支持降噪、均衡器、压缩等高级音频效果处理功能,全面满足用户的使用需求。同时,Audacity...
Drive SnapShot是一款性能出色的系统备份与恢复工具,集成远程备份、差异备份、还原硬盘等多项功能,并支持定时自动备份。Drive SnapShot无需安装,即开即用,提供中文界面,操作简单便捷,能够...
发表评论
共0条
评论就这些咯,让大家也知道你的独特见解
立即评论以上留言仅代表用户个人观点,不代表系统之家立场