从0到1 手把手搭建spring cloud alibaba 微服务大型应用框架(七) 开发环境使用轻量级在线文档解决知识分享问题

本文涉及的产品
MSE Nacos 企业版免费试用,1600元额度,限量50份
任务调度 XXL-JOB 版免费试用,400 元额度,开发版规格
云原生网关 MSE Higress,422元/月
简介: 从0到1 手把手搭建spring cloud alibaba 微服务大型应用框架(七) 开发环境使用轻量级在线文档解决知识分享问题

题外话


有没有过想看某个项目资料或者接口或者文档资料等怎么都找不到的精力,或者有一堆文档,但是不知道自己想要找的内容在哪个文档里?恭喜你不要999,也不要99 ,只要0.0元 在线文档送到家 ( ^_^ )


本节本身和mini cloud 框架本身关系不大,但是和每个人都有着紧密联系,毕竟每个人的开发都离不开框架文档,接口文档,详设文档等,这节主要是给大家分享一个轻量级适合中小团队和公司得在线文档系统 mrDoc  

1.png 进入正题


什么才算是在线文档系统,为什么要使用在线文档


首先我们来聊一下为什么开发环境需要一个在线文档系统,聊之前首先我们得确认一下什么是在线文档系统,是不是一个地址文档可以下载就算在线文档系统了呢,我个人觉得,算也不算,这个得看具体使用场景,如果说文档明细已经做的很好了,有一个文档明确记录了哪个文档得下载地址以及划分明确,并且变动不大的情况下,其实是可以满足一般需求得,但是如果文档是一个生命周期的过程中而不是结束了归档了,那么其实是不符合在线文档系统需求的,我觉得一般需要具备以下特点:

### 1.可以在线编辑,预览,最好可以支持word 格式上传
### 2.可以进行版本管理与对比
### 3.可以进行权限控制,也就是哪些角色可以对这个文档做什么事
### 4.可以对文档进行父子关系或者关联关系管理
### 5.可以全文检索

我觉得具备了以上特点的才可称之为在线文档系统,我们很多开发环境用git或者svn进行文档管理,它具备了共享,在线预览权限管理等特点,但是对都是基于目录层级或者项目级别的,不具备父子关联关系管理,所以我觉得不算是在线文档系统


目前比较常用的在线文档


### 说了这么多,那市面上比较常用的一些在线文档是哪些呢
### gitbook: 其实github,gitlab本身就自持自家系列的文档系统gitbook,而且功能强大,和git无缝对接,但是我觉得就是因为追求通用以及功能强大
### 导致了过于重,如果是大型团队或者公司我比较推荐这个
### wiki:是国内外比较通用的文档系统,但是一样操作繁琐复杂度高,我觉得如果中小公司或者团队可以选择我推荐的mrDoc
### lanhu:蓝狐一般是针对前端的,但是其实可以作为在线文档系统去使用,但是无法私有部署
### 语雀:和蓝狐一样,都挺好就是无法私有化部署
### mrDoc:今天主要我推荐的就是这个,很轻量,但是该有的功能都有,操作符合国人习惯

mrDoc 优缺点


### 优点:可以在线预览编辑,也支持多格式编辑,还有支持导入导出功能,可以全文检索,也具备权限管理功能,还有桌面客户端,还可以进行独立得素材管理,最重要的是很轻量,部署也方便
### 缺点:由于刚刚起部,权限管理以及下载格式支持的还够完善

mrDoc docker部署开源版


一、拉取 MrDoc 代码
进入目录:
cd /opt
开源版:
git clone https://gitee.com/zmister/MrDoc.git
二、获取 Docker 镜像
方式一:拉取镜像
docker pull zmister/mrdoc:v4
三、运行 Docker 容器
开源版:
docker run -d --name mrdoc -p 10086:10086 -v /opt/MrDoc:/app/MrDoc zmister/mrdoc:v4
四、管理
创建管理员账户
docker exec -it mrdoc python manage.py createsuperuser
修改用户密码
docker exec -it mrdoc python manage.py changepassword 用户名
停止容器
docker stop mrdoc
启动容器
docker start mrdoc
删除容器
docker rm -f mrdoc

部署后访问服务器ip +端口号10086,首页如下

1.png

mrDoc 使用 ,以下列举几个常用功能


创建文集:如果按照项目管理的话,一般就是一个项目创建一个文集,如图是我们项目即将启动之前我对项目创建了一个文集,然后放上去一些共通文档和开发文档,因为需求还在调研,所以还没放需求文档和逻辑文档


1.png

创建文档:文档隶属于某个文集,也可以设置其他文档为自己的父类,最终形成树形结构


个人中心:在里面可以管理自己的文档以及一些属性


1.png

后台管理:如果是超级管理员,则可以进行其他文档的管理,也可以进行用户管理等


1.png


总结:如果是中小行公司或者团队,推荐使用mrDoc,确实好用~

目录
打赏
0
0
0
0
18
分享
相关文章
1天消化完Spring全家桶文档!DevDocs:一键深度解析开发文档,自动发现子URL并建立图谱
DevDocs是一款基于智能爬虫技术的开源工具,支持1-5层深度网站结构解析,能将技术文档处理时间从数周缩短至几小时,并提供Markdown/JSON格式输出与AI工具无缝集成。
142 1
1天消化完Spring全家桶文档!DevDocs:一键深度解析开发文档,自动发现子URL并建立图谱
|
4月前
|
微服务——SpringBoot使用归纳——Spring Boot中集成 Shiro——Shiro 身份和权限认证
本文介绍了 Apache Shiro 的身份认证与权限认证机制。在身份认证部分,分析了 Shiro 的认证流程,包括应用程序调用 `Subject.login(token)` 方法、SecurityManager 接管认证以及通过 Realm 进行具体的安全验证。权限认证部分阐述了权限(permission)、角色(role)和用户(user)三者的关系,其中用户可拥有多个角色,角色则对应不同的权限组合,例如普通用户仅能查看或添加信息,而管理员可执行所有操作。
152 0
微服务——SpringBoot使用归纳——Spring Boot中集成 Shiro——Shiro 三大核心组件
本课程介绍如何在Spring Boot中集成Shiro框架,主要讲解Shiro的认证与授权功能。Shiro是一个简单易用的Java安全框架,用于认证、授权、加密和会话管理等。其核心组件包括Subject(认证主体)、SecurityManager(安全管理员)和Realm(域)。Subject负责身份认证,包含Principals(身份)和Credentials(凭证);SecurityManager是架构核心,协调内部组件运作;Realm则是连接Shiro与应用数据的桥梁,用于访问用户账户及权限信息。通过学习,您将掌握Shiro的基本原理及其在项目中的应用。
152 0
飞算 JavaAI:革新电商订单系统 Spring Boot 微服务开发
在电商订单系统开发中,传统方式耗时约30天,需应对复杂代码、调试与测试。飞算JavaAI作为一款AI代码生成工具,专注于简化Spring Boot微服务开发。它能根据业务需求自动生成RESTful API、数据库交互及事务管理代码,将开发时间缩短至1小时,效率提升80%。通过减少样板代码编写,提供规范且准确的代码,飞算JavaAI显著降低了开发成本,为软件开发带来革新动力。
Java 21 与 Spring Boot 3.2 微服务开发从入门到精通实操指南
《Java 21与Spring Boot 3.2微服务开发实践》摘要: 本文基于Java 21和Spring Boot 3.2最新特性,通过完整代码示例展示了微服务开发全流程。主要内容包括:1) 使用Spring Initializr初始化项目,集成Web、JPA、H2等组件;2) 配置虚拟线程支持高并发;3) 采用记录类优化DTO设计;4) 实现JPA Repository与Stream API数据访问;5) 服务层整合虚拟线程异步处理和结构化并发;6) 构建RESTful API并使用Springdoc生成文档。文中特别演示了虚拟线程配置(@Async)和StructuredTaskSco
80 0
基于 Spring Cloud 的微服务架构分析
Spring Cloud 是一个基于 Spring Boot 的微服务框架,提供全套分布式系统解决方案。它整合了 Netflix、Zookeeper 等成熟技术,通过简化配置和开发流程,支持服务发现(Eureka)、负载均衡(Ribbon)、断路器(Hystrix)、API网关(Zuul)、配置管理(Config)等功能。此外,Spring Cloud 还兼容 Nacos、Consul、Etcd 等注册中心,满足不同场景需求。其核心组件如 Feign 和 Stream,进一步增强了服务调用与消息处理能力,为开发者提供了一站式微服务开发工具包。
125 0
微服务——SpringBoot使用归纳——Spring Boot中集成ActiveMQ——ActiveMQ安装
本教程介绍ActiveMQ的安装与基本使用。首先从官网下载apache-activemq-5.15.3版本,解压后即可完成安装,非常便捷。启动时进入解压目录下的bin文件夹,根据系统选择win32或win64,运行activemq.bat启动服务。通过浏览器访问`http://127.0.0.1:8161/admin/`可进入管理界面,默认用户名密码为admin/admin。ActiveMQ支持两种消息模式:点对点(Queue)和发布/订阅(Topic)。前者确保每条消息仅被一个消费者消费,后者允许多个消费者同时接收相同消息。
109 0
微服务——SpringBoot使用归纳——Spring Boot中集成ActiveMQ——ActiveMQ安装
微服务——SpringBoot使用归纳——Spring Boot中集成ActiveMQ——发布/订阅消息的生产和消费
本文详细讲解了Spring Boot中ActiveMQ的发布/订阅消息机制,包括消息生产和消费的具体实现方式。生产端通过`sendMessage`方法发送订阅消息,消费端则需配置`application.yml`或自定义工厂以支持topic消息监听。为解决点对点与发布/订阅消息兼容问题,可通过设置`containerFactory`实现两者共存。最后,文章还提供了测试方法及总结,帮助读者掌握ActiveMQ在异步消息处理中的应用。
139 0
微服务——SpringBoot使用归纳——Spring Boot中集成ActiveMQ——ActiveMQ集成
本文介绍了在 Spring Boot 中集成 ActiveMQ 的详细步骤。首先通过引入 `spring-boot-starter-activemq` 依赖并配置 `application.yml` 文件实现基本设置。接着,创建 Queue 和 Topic 消息类型,分别使用 `ActiveMQQueue` 和 `ActiveMQTopic` 类完成配置。随后,利用 `JmsMessagingTemplate` 实现消息发送功能,并通过 Controller 和监听器实现点对点消息的生产和消费。最后,通过浏览器访问测试接口验证消息传递的成功性。
124 0
AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等