一、ShowDoc介绍
1.ShowDoc简介
ShowDoc是一个非常适合IT团队的在线API文档、技术文档工具。通过showdoc,你可以方便地使用markdown语法来书写出美观的API文档、数据字典文档、技术文档、在线excel文档等等。
2.ShowDoc功能
分享与导出
响应式网页设计,可将项目文档分享到电脑或移动设备查看。同时也可以将项目导出成word文件,以便离线浏览。
权限管理
1.公开项目与私密项目:ShowDoc上的项目有公开项目和私密项目两种。公开项目可供任何登录与非登录的用户访问,而私密项目则需要输入密码验证访问。密码由项目创建者设置。
2.项目转让:项目创建者可以自由地把项目转让给网站的其他用户。
3.项目成员:你可以很方便地为ShowDoc的项目添加、删除项目成员。项目成员可以对项目进行编辑,但不可转让或删除项目(只有项目创建者才有权限)。
4.团队管理:利用showdoc的团队功能你可以更好地进行团队协作。
编辑功能
1.markdown编辑:ShowDoc采用markdown编辑器,无论是编辑还是阅读体验都极佳很棒。
2.模板插入:在ShowDoc的编辑页面,点击编辑器上方的按钮可方便地插入API接口模板和数据字典模板。
3.历史版本:ShowDoc为页面提供历史版本功能,你可以方便地把页面恢复到之前的版本。
多平台
showdoc支持网页版、手机app版和电脑客户端版。客户端地址可见:https://www.showdoc.com.cn/clients。
自动化
1.可从代码注释中自动生成文档。
2.搭配的RunApi客户端,可调试接口和自动生成文档。
mkdir -p /showdoc/html chmod -R 777 /showdoc/html docker run -d --name showdoc --user=root --privileged=true -p 4999:80 --restart always -v /showdoc/html:/var/www/html/ star7th/showdoc
标签:项目,--,showdoc,html,文档,Docker,ShowDoc From: https://www.cnblogs.com/libruce/p/17812634.html