首页 > 其他分享 >Docker部署ShowDoc文档工具

Docker部署ShowDoc文档工具

时间:2023-11-06 14:45:41浏览次数:27  
标签:项目 -- showdoc html 文档 Docker ShowDoc

一、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

相关文章

  • Word文档审阅批注作者姓名更改方法
     审阅--跟踪--选项--修改用户名:     ......
  • Docker 配置 Wordpress
    1.拉取镜像dockerpullwordpress:latest2.创建存储卷dockervolumecreatewordpress_data3.创建容器dockerrun--namewordpress-chao--restart=always--linkmysql:mysql-p8011:80-d\-vwordpress_data:/var/www/htmlwordpress----外部数据库docker......
  • Docker安装部署
    传统虚拟机技术虚拟机是虚拟出一套硬件,在其上面运行一个完整的操作系统给,例如我们使用KVM,指定系统镜像,然后装系统,最终可以使用,在该系统上再运行所需的应用程序。KVM创建虚拟机是,指定较少的cpu,内存,硬盘等资源,虚拟机性能较低。容器技术容器内的应用程序直接运行再宿主机的内......
  • docker 搭建 rocketmq 本地环境
    如果你还没有安装Docker,请先安装。可以参考官方文档docs.docker.com/install/进行安装NameServernameserver就类似kafka集群中使用的zookeeper负责集群的管理注册和发现。1.拉取镜像dockerpullapache/rocketmq2.创建NameServer容器创建一个新的容器并指定RocketMQ的镜......
  • Docker从入门到部署项目
    Docker概念Docker是一个开源的应用容器引擎,它是基于Go语言并遵从Apache2.0协议开源。Docker可以让开发者打包他们的应用以及依赖包到一个轻量级、可移植的容器中,然后发布到任何流行的linux机器上,也可以实现虚拟化。通过容器可以实现方便快速并且与平台解耦的自动化部署方式,无论你部......
  • /var/lib/docker/overlay2/41a765b3cfaa278a67414c5b89234adfdebac7182d4bcd1e7c8a2c6
    现象:Error:Errorresponsefromdaemon:errorcreatingoverlaymountto/var/lib/docker/overlay2/41a765b3cfaa278a67414c5b89234adfdebac7182d4bcd1e7c8a2c6ac250dfb7-init/merged:nosuchfileordirectory原因:由于Docker存储空间中的一些残留文件或损坏的文件系统引......
  • 使用Github Actions构建Docker image
    需求因为网络和性能的原因,有些Dockerfile无法在本地顺利构建。我们可以借助GithubActions每月2000分钟的免费时间来构建。实现在你的仓库里放好Dockerfile如果需要安装文件等操作也一并push建立.github/workflows/main.yml描述任务name:DockerImageCIon:push:......
  • 浅析幼儿园大班教室环境创设的策略研究——文档
    环境在人类身上起着潜移默化的影响,它在人的各个方面的成长过程中始终蕴含着十分重要的过去。自然环境在事物中的作用应该被我们充分认识到。人们常说:余君子交如芝兰之室,久闻其清香:余恶人交如鲍鱼之市,久闻其异味。凡此种种,无不说明自然环境给人类带来的巨大作用。由于我们每一个人......
  • Sandcastle生成文档
    下载:https://github.com/EWSoftware/SHFB/releases使用Sandcastle生成Api文档需要使用对应程序集的注释xml+程序集dll作为数据源,通过对xml+dll数据解析生成文档;所以主体步骤如下:程序集资源生成创建配置.shfbproj项目编译构建文档程序集资源生成生成程序集ApiXml配......
  • 幼儿园区角中阅读指导的现状及对策研究(论文文档)
    随着知识经济时代的来临以及终身教育理念的倡导,幼儿阅读教育的重要性口益凸显。只有具有良好阅读意识、能力、习惯和情感态度的人,才能够实现终身学习和终身发展,发掘自己的最大潜能,达到自己的最佳发展水平。幼儿园是幼儿所接触到的第一所指导其阅读学习的专业场所,幼儿教师是幼儿阅读......