官方中文教程:https://www.showdoc.com.cn/help/1385767280275683
ShowDoc是一个非常适合IT团队的在线API文档、技术文档工具。通过showdoc,你可以方便地使用markdown语法来书写出美观的API文档、数据字典文档、技术文档、在线excel文档等等。如果不想编辑markdown文档,你还可以利用showdoc的自动化能力,从程序注释中自动生成API文档,或者从搭配的RunApi客户端(类似postman的api调试工具)中一边调试接口、一边自动生成文档。通过分配项目成员和团队成员,你可以很方便地进行项目文档的权限管理和团队协作,也可以分享文档出去给朋友查看。ShowDoc还支持多平台客户端,有win客户端、mac客户端、ios、android等,更方便跨平台使用。目前超过100000+的互联网团队正在使用showdoc,包括知名公司内部的一些团队,比如腾讯、华为、百度、京东、字节跳动等等。
具体操作如下:
1.点击“ADD CONTAINER”添加容器
2.下载"showdoc"仓库
name:showdoc
Repository:star7th/showdoc
参数等下载完以后再设置,避免设置后之后下载失败,功亏一篑
3.参数设置
单击docker图标,再点击showdoc的“Edit”选项进入编辑页面
点击下方的“+ Add another Path, Port, Variable, Label or Device” 新增参数
Config Type:Port;
Container Port:80;
Host Port:根据实际情况填写
映射配置文件:
Config Type:Path;
Container Path:/app
Host Path:/mnt/user/appdata/showdoc
确认无误后点击“APPLY”提交
4.首次登录
打开 http://localhost:端口号 来访问showdoc (localhost可改为你的服务器域名或者IP)。
账户密码是showdoc/123456,登录后你便可以看到右上方的管理后台入口。
建议登录后修改密码。