NAS下搭建一个非常适合IT团队的 在线API文档、技术文档工具

释放双眼,带上耳机,听听看~!

前言

今天要介绍的是一款官方称自己最适合IT团队的知识文档工具和API管理工具——showdoc。
通过showdoc,你可以方便地使用markdown语法来书写出美观的API文档、数据字典文档、技术文档、在线excel文档等等。值得一提的是ShowDoc还支持多平台客户端,有win客户端、mac客户端、ios、android等,更方便跨平台使用。那么咱们今天就部署看一下该项目到底怎么样。

部署

showdoc的部署很简单,首先我们需要在docker文件夹中新建一个showdoc文件夹用于之后的容器路径设置。

640
准备工作

随后在docker注册表中搜索star7th/showdoc并下载,如果没有特殊版本的要求,那么直接拉取latest就可以了。

640-1
容器

随后我们将showdoc文件夹映射到本地,映射路径为/var/www/html/。端口方面如果没有特殊需求,只需要映射80端口就行了,其他的可以不用管。

640-2
映射设置

所有设置好之后启动容器即可。浏览器输入http://nasip+本地端口即可访问初始化界面了。初始化很简单,首先让你选择语言,选择后便会直接显示已初始化,并会显示默认的账号密码为showdoc/123456。

640-3
初始化

体验

再次输入地址便能跳转到项目界面了,该项目的登录界面在右上角,输入默认的账号密码便能进入系统了。

640-4
主界面

主界面很简约,并且有几个示例文件,帮助第一次部署的人了解该项目。

640-5
管理后台

点击齿轮标志进入管理后台,设置项并不是很多。而且对于权限的管理也没有展示出来,如果对用户权限有要求的,那么该容器可能并不是很适合你。

640-6
新建项目

新建项目中有常规的项目,也有电子表格和单页项目,三种新建给了用户选择,并可以选择项目是否公开。

总结

该项目功能性我可能用不到,毕竟关于API部分的内容,我的确看不懂,如果有懂行的大佬,可能会有用。这样看来该项目依然是专人专用的项目,并不是每个人都适用

温馨提示:本文最后更新于 2023-07-15 00:39 ,某些文章具有时效性,若有错误或已失效,请在下方留言或联系逆念

给TA打赏
共{{data.count}}人
人已打赏
源码插件

解析QQ收藏api接口(无加密)

2022-12-9 22:59:44

源码插件

vikunja——高颜值的to-do任务列表

2024-4-16 21:55:14

重要声明

本站资源大多来自网络,如有侵犯你的权益请联系管理员,QQ508044570 我们会第一时间进行审核删除。站内资源为网友个人学习或测试研究使用,未经原版权作者许可,禁止用于任何商业途径!请在下载24小时内删除!


如果遇到付费才可观看的文章,建议升级终身VIP。全站所有资源任意下免费看”。本站资源少部分采用7z压缩,为防止有人压缩软件不支持7z格式,7z解压,建议下载7-zip,zip、rar解压,建议下载WinRAR

0 条回复 A文章作者 M管理员
    暂无讨论,说说你的看法吧
个人中心
购物车
优惠劵
今日签到
有新私信 私信列表
搜索