ShowDoc部署与应用:文档管理的最佳实践

在项目开发和协作中,文档管理扮演着至关重要的角色。ShowDoc作为一款卓越的开源文档管理工具,不仅提供强大的文档管理功能,还具备简单易用的协作和部署特性。我们的项目团队最初选择了ShowDoc作为文档管理工具,用以促进前后端协作。在本文中,我们将深入探讨ShowDoc,并为您演示如何轻松部署和充分利用这一卓越工具。

showdocc.jpg

ShowDoc简介

ShowDoc 是一款用于创建和管理文档的工具,旨在帮助团队更好地记录、分享和协作。以下是 ShowDoc 的一些重要特性:

  • 强大的文档管理

ShowDoc 提供了丰富的文档管理功能,支持创建和维护各种类型的文档,包括API文档、项目文档、接口文档等。

  • 多种文档模板

ShowDoc 提供多种文档模板,可根据不同需求创建不同类型的文档。这些模板包括流程图、表格、接口文档等。

  • 团队协作

ShowDoc 允许团队成员协作编辑文档,多人协作变得轻而易举。每次编辑都有明确的记录,便于追踪和管理。

  • 版本管理

ShowDoc 支持文档的版本管理,您可以轻松查看和恢复以前的版本,确保文档的历史完整性。

  • 导出和分享

您可以将文档导出为HTML、Markdown等格式,并分享给项目成员或其他相关方。

ShowDoc私有化部署

第一步:创建docker-compose.yml 文件

创建docker-compose.yml

version: '3.5'
services:showdoc:image: star7th/showdoccontainer_name: showdochostname: showdocrestart: alwayslogging:driver: 'json-file'options:max-size: '5g'ports:- 4999:80volumes:- ./data/html:/var/www/htmlprivileged: trueuser: root

第二步:启动容器

在docker-compose.yml 同级目录下执行以下命令启动容器:

docker-compose up -d 

赋予挂载目录data权限

sudo chmod -R 777 data

第三步:访问服务

在浏览器中访问地址: http://192.168.10.106:4999/

默认用户名:showdoc

默认密码: 123456

_20230929222729.png

_20230929222744.png

_20230929225704.png

_20230929230845.png

到此,我们showdoc 私有化部署就完成了。

ShowDoc使用

  • 后台管理

ShowDoc提供了直观的可视化管理界面,包括项目、团队和成员管理功能。通过这些界面,我们可以轻松管理相关信息。

_20230929231259.png

  • RunApi接口调试

runapi是一个以接口为核心的开发测试工具(功能上类似postman), 包含接口测试/自动流程测试/Mock数据/项目协作等功能。它和showdoc( https://www.showdoc.com.cn/help )相辅相成:showdoc以文档为核心,侧重文档编写和知识资料沉淀。而runapi则以接口为核心,包含接口测试、管理、Mock数据、自动化流程测试等一系列功能。同时它将自动生成文档到showdoc,无须再手动编写文档,释放生产力;共用showdoc的团队管理机制,很好地实现接口的自动化和多人协作。相信使用 showdoc + runapi 这两个工具组合,能够极大地提高IT团队的效率。

下载安装RunApi

_20230929223118.png

_20230929223131.png

安装之后打开RunApi

填写showdoc信息

_20230929223358.png

_20230929231908.png

生成文档之后可以在showdoc页面直接查看

_20230929232038.png

总结

ShowDoc 是一款功能强大的文档管理工具,它为团队协作和文档管理提供了理想的平台。无论您是开发团队的一员还是独立开发者,ShowDoc都可以帮助您更好地组织和分享文档。通过简单的部署和易用的界面,ShowDoc为您的项目带来更高的效率和可维护性。不妨尝试部署ShowDoc,看看它如何改善您的文档管理流程!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.rhkb.cn/news/144754.html

如若内容造成侵权/违法违规/事实不符,请联系长河编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

【算法】莫队

这篇博客起源于本人把一道 p o w ( 2 , n ) pow(2,n) pow(2,n) 的问题考虑成求组合数前缀和的问题qwq,于是接触到了这个新算法来总结一下 参考自这篇文章,写得太好了 首先是一道模板题 题目意思是,给出一个数组a,再给出多个区…

nginx 多层代理 + k8s ingress 后端服务获取客户真实ip 配置

1.nginx http 七层代理 修改命令空间: namespace: nginx-ingress : configmap:nginx-configuration kubectl get cm nginx-configuration -n ingress-nginx -o yaml添加如上配置 compute-full-forwarded-for: “true” forwarded-for-header: X-Forwa…

点击、拖拉拽,BI系统让业务掌握数据分析主动权

在今天的商业环境中,数据分析已经成为企业获取竞争优势的关键因素之一。然而,许多企业在面对复杂的数据分析工具时,却常常感到困扰。这些工具往往需要专业的技术人员操作,而且界面复杂,难以理解和使用。对业务人员来说…

JDK17新特性

为什么要升级JDK17 JDK17带来了哪些变化 swtich语句增强 // jdk8switch int statusCode 0; String statusName ""; switch (statusCode) {case 1:statusName "开始";break;case 2:statusName "进行中";break;case 3:statusName "结束…

【ARMv8 SIMD和浮点指令编程】NEON 加载指令——如何将数据从内存搬到寄存器(LDxLDxR)?

将内存中的数据搬到 NEON 寄存器,有很多指令可以完成,熟悉这些指令是必须的。 1 LD1 (multiple structures) 将多个单元素结构加载到一个,两个,三个或四个寄存器上。该指令从内存中加载多个单元结构,并将结果写入一、二、三或四个 SIMD&FP 寄存器。 无偏移 一个寄存…

基于nodejs+vue办公OA公文发文件管理系统

论文的研究内容包括:公文分类、公文信息、待办提醒等方面进行了研究。系统以当前应用最为广泛的nodejs语言为基础,结合了目前应用最为广泛的嵌入式嵌入式平台,集成了B/S体系结构。数据库选择简便高效的MySQL,vue框架。在OA公文发文…

简单理解旁路电容和去耦电容

1、本文内容如有错误,欢迎交流指正。 2、本文仅作为本人学习笔记,部分内容来源于网络、书籍,如涉及侵权,请联系删除。 什么是旁路电容? 旁路电容的英文原文是Bypass capacitor,bypass就是绕过,避…

Spring修炼之路(2)依赖注入(DI)

一、概念 依赖注入(Dependency Injection,DI)。 测试pojo类 : Address.java 依赖 : 指Bean对象的创建依赖于容器 . Bean对象的依赖资源 . 注入 : 指Bean对象所依赖的资源 , 由容器来设置和装配 . 二、 注入方式 2.1构造器注入 我们在之前的案例已经…

系统集成|第十二章(笔记)

目录 第十二章 沟通管理12.1 沟通的基本概念12.2 主要过程12.2.1 规划沟通管理12.2.2 管理沟通12.2.3 控制沟通 12.3 常见问题 上篇:第十一章、项目人力资源管理 下篇:第十三章、干系人管理 第十二章 沟通管理 沟通管理在项目计划、执行、监控过程中具有…

echarts添加点击事件

实现效果:点击图表,弹出该数据下对应得详情 官方文档: 封装的图表组件中: 点击获取点击得对象,进而将需要的参数传给父组件,在父组件中再去请求接口获取更多信息 this.chart.on(click, (params)> {th…

C# 数组

C# 数组 数组简单数组多维数组锯齿数组Array类数组的接口枚举 数组 如果需要使用同一类型的多个对象,就可以使用集合和数组。C#用特殊的记号声明和使用数组。 简单数组 在声明数组时,应先定义数组中元素的类型,其后是一个空方括号和一个变…

Docker 自动化部署(保姆级教程)

Docker 自动化部署 1. jenkins 介绍1.1 参考链接:1.2 jenkins 概述1.3 jenkins部署项目的流程 2. jenkins 安装2.1 基于docker 镜像2.2 启动 jenkins 后端服务2.3 登录 jenkins 服务后端 3. jenkins自动化部署开始3.1 下载需要的插件3.2 创建任务3.2.1 描述3.2.2 配…

【图论C++】树的重心——教父POJ 3107(链式前向星的使用)

》》》算法竞赛 /*** file * author jUicE_g2R(qq:3406291309)————彬(bin-必应)* 一个某双流一大学通信与信息专业大二在读 * * brief 一直在竞赛算法学习的路上* * copyright 2023.9* COPYRIGHT 原创技术笔记:转载…

Neo4j-双向关系

概述 这是GraphAware中关于双向关系的解释。 网址链接Modelling Data in Neo4j: Bidirectional Relationships | GraphAware 定向关系 Neo4j中的关系必须有一个语义化的类型和方向。 没有方向关系是模棱两可的,上面A队打败B队,如果没有方向&#xff0c…

AOP 编程

目录 ​编辑一、AOP 编程 1、AOP 概念 2、AOP 编程的开发步骤 3、切面的名词解释 二、AOP 的底层实现原理 1、核心问题 2、动态代理类的创建 (1)JDK 的动态代理创建 (2)CGlib 的动态代理 (3)总结…

支持笔记本电脑直插直充,TOWE 65W智能快充PDU超级插座

电源插排在我们的生活中是必不可少的电器配件。今天,我们日常生活中所使用的电子设备越来越多,无论是手机、平板、笔记本电脑还是各种家用电器,都需要电源来驱动。虽然相对于其他电器来说,插排结构比较简单,但现代家庭…

设计模式5、原型模式 Prototype

解释说明:使用原型实例指定待创建对象的类型,并且通过复制这个原型阿里创建型的对象 UML 结构图: 抽象原型(Prototype):规定了具体原型对象必须实现的clone()方法 具体原型(ConcretePrototype&…

【我的创作纪念日】使用pix2pixgan实现barts2020数据集的处理(完整版本)

使用pix2pixgan (pytorch)实现T1 -> T2的基本代码 使用 https://github.com/eriklindernoren/PyTorch-GAN/ 这里面的pix2pixgan代码进行实现。 进去之后我们需要重新处理数据集,并且源代码里面先训练的生成器,后训练鉴别器。 一般情况下…

计算机图像处理-均值滤波

均值滤波 线性滤波器的原始数据与滤波结果是一种算术运算,即用加减乘除等运算实现,如均值滤波器(模板内像素灰度值的平均值)、高斯滤波器(高斯加权平均值)等。由于线性滤波器是算术运算,有固定…

Android Jetpack Compose之确定重组范围并优化重组

1.概述 Compose的重组是智能的,Composable函数在进行重组时会尽可能的跳过不必要的重组,只对需要变化的UI进行重组。那Compose是如何认定UI需要变化呢?或者换句话说Compose是如何确定重组的范围呢。如果重组随意的发生,那么对UI的…