MyBatis Mapper 文档站

基于 VuePress 2.x 构建的 MyBatis Mapper 文档站点。

快速开始

# 安装依赖
npm install

# 启动开发服务器
npm run docs:dev

# 构建生产版本
npm run docs:build

项目结构

├── docs/
│   ├── .vuepress/
│   │   ├── config.js          # 核心配置（站点信息/导航栏/侧边栏/搜索）
│   │   └── public/            # 静态资源（图片等）
│   ├── index.md               # 首页（Hero + Features）
│   └── docs/
│       ├── v2.x/              # v2.x 使用指南（16 页）
│       ├── v4.3.x/            # v4.3.x 使用指南（16 页）
│       ├── vuepress/          # VuePress 2.x 文档（32 页）
│       └── extend/            # 深度指南（3 页）
├── doc/                       # 过程文档归档
│   ├── 01-architecture-design.md
│   ├── 02-implementation-log.md
│   ├── 03-summary.md
│   ├── 04-completion-report.md
│   └── 05-quick-start-guide.md  ← 二次开发零基础教程
└── package.json

技术栈

技术	版本	说明
VuePress	2.0.0-rc.31	静态站点生成器
Vue	3.5.x	底层框架
Vite	-	构建工具
Algolia DocSearch	-	全文搜索

文档内容

• v2.x 使用指南：快速上手、Mapper 接口、实体类注解、common/service/activerecord 模块、代码生成器
• v4.3.x 使用指南：快速上手、Mapper 接口、JPA 注解、Spring Boot 配置、Weekend Lambda 查询
• VuePress 2.x 文档：指南、参考、深入（32 页完整复刻）
• 深度指南：扩展接口调用顺序、实体通用字段全局设置、MyBatis 枚举使用指南

二次开发

想基于本项目模板搭建自己的文档站？查看 二次开发零基础教程。

部署

构建产物在 dist/ 目录下，可部署到 GitHub Pages、Vercel、Netlify 等平台。

许可

Apache License 2.0 | Copyright (c) 2021 Liuzh