mms-docs 模块(实现文档知识付费)
简介
mms-docs，是用于 [VitePress 会员主题] 基于VitePress默认主题做扩展，实现部分内容会员可见，用于做知识付费文档网站。
🎉 Go语言版本
官方是Go语言服务接口工程 ，会Go语言的朋友请直接使用[VitePress 会员主题] 的服务即可。
🎉 Java语言版本
基于 [mmsAdmin]项目，扩展的 ‘会员主题’ Java版本。
说明
下面是 VitePress 会员主题 Java语言版本的使用教程。
一、获取代码
- 后端接口服务
获取mmsAdmin的 doc 分支代码
# 第一步:克隆远程仓库指定 doc 分支到本地
git clone -b doc --single-branch https://gitee.com/mmsAdmin/mms.git
# 第二步:进入 mms
cd mms
# 第三步:强制更新子项目 mms-docs
git -c credential.helper= submodule update --init --recursive --force[Git命令扩展]
-b 是 --branch 的简写，指定要克隆的分支名称为 doc，不指定默认检出 主分支 master/main
--single-branch 只克隆指定的单个分支，减少克隆时间和磁盘空间占用
-c credential.helper= 时禁用 Git 的凭证存储功能
=后为空表示清空该配置，不使用任何凭证助手。--remote 直接拉取子模块远程仓库的最新提交 (
.gitmodules中指定的分支仓库)--recursive 递归更新所有嵌套子模块（子模块内的子模块）
git submodule init 子模块初始化
git submodule init mms-docs 初始化特定子模块（如 mms-docs）
git submodule update 拉取/更新子模块
git submodule update --init 初始化+拉取一步完成
git submodule update mms-docs 拉取特定子模块
git submodule update --remote 跟踪 .gitmodules中指定的分支仓库拉取
git submodule update --init --recursive 处理嵌套子模块
git branch 查看当前分支
git remote -v 查看远程连接
git fetch --all 获取所有分支信息（不下载内容）
git checkout master 切换到新分支（如 master）
git pull origin <分支名> 默认分支可以省略origin <分支名>
git status 查看文件状态
git add mms-docs 添加暂存区 git add ./*
git commit -m "更新子模块" 提交到本地仓库
git push [远程仓库] [本地分支]:[远程分支] 提交到远程仓库
git push origin dev 推送当前分支到远程的dev分支
git push --force origin dev 强制覆盖远程 dev 分支
- VitePress会员主题，
mms-doc适配版
由于[mmsAdmin] 的接口响应格式和原官方接口有差异，所有 [VitePress 会员主题] 模版有做接口的优化调整升级，最新主题代码请 添加主微信，进微信群可免费下载领取。
二、父工程的 pom.xml
版本控制
- 将下面代码添加到
dependencies节点中
<!-- 文档管理模块-->
<dependency>
<groupId>com.sxpcwlkj</groupId>
<artifactId>mms-doc-admin</artifactId>
<version>${revision}</version>
</dependency>
<!-- 文档API模块-->
<dependency>
<groupId>com.sxpcwlkj</groupId>
<artifactId>mms-doc-api</artifactId>
<version>${revision}</version>
</dependency>安装模块
- 将下面代码添加到添加到
modules节点中
<module>mms-docs</module>后台系统引入
模块 mms-admin 下的 pom.xml 文件中的dependencies 节点添加下面代码
<!-- 文档Admin管理模块-->
<dependency>
<groupId>com.sxpcwlkj</groupId>
<artifactId>mms-doc-admin</artifactId>
<version>${revision}</version>
</dependency>将 mms-docs 文件夹设置为Maven项目
示例:
三、启动
检查依赖
完成以上组装，需要刷新 Maven 会得到 mms-docs模块 mms-admin 依赖正常引入。
微信配置
- mmsAdmin 集成微信登录，和微信支付功能模块，所有利用后台系统的微信配置功能，对接次文档项目的微信扫码登录和微信支付功能
- 首先你已经顺利的启动 mmsAdmin 的
mms-admin系统管理模块，如果没有请前往 后端启动 完成启动，因为此模块会初始化一些微信配置的缓存配置。 - 配置微信配置,详细配置请查看 mmsAdmin 微信配置文档。
导入数据库
数据库的导入: mms-docs模块下的 db 文件夹 执行 mms-doc.sql 到自己的数据库，具体这个按照 mms-doc-api 的数据源的数据库而定，如果不考虑分库可以添加到 mms 数据库。
启动接口服务
启动mms-doc-api模块下的 MmsDocApiApplication.java 中的 启动 main 方法启动。
