一、ShowDoc介绍
ShowDoc是一个适合IT团队共同协作API文档、技术文档的工具。通过showdoc,可以方便地使用markdown语法来书写出API文档、数据字典文档、技术文档、在线excel文档等等。
响应式网页设计:可将项目文档分享到电脑或移动设备查看。同时也可以将项目导出成word文件,以便离线浏览。
公开项目与私密项目:ShowDoc上的项目有公开项目和私密项目两种。公开项目可供任何登录与非登录的用户访问,而私密项目则需要输入密码验证访问。密码由项目创建者设置。
项目转让:项目创建者可以自由地把项目转让给网站的其他用户。
项目成员:你可以很方便地为ShowDoc的项目添加、删除项目成员。项目成员可以对项目进行编辑,但不可转让或删除项目(只有项目创建者才有权限)。
团队管理:利用showdoc的团队功能你可以更好地进行团队协作。
markdown编辑:ShowDoc采用markdown编辑器,无论是编辑还是阅读体验都极佳很棒。
模板插入:在ShowDoc的编辑页面,点击编辑器上方的按钮可方便地插入API接口模板和数据字典模板。
历史版本:ShowDoc为页面提供历史版本功能,你可以方便地把页面恢复到之前的版本。
二、本次实践介绍
-
本次实践简介
本次实践部署环境为个人测试环境
-
本地环境规划
本次实践环境规划:下载