From 4eee1419d366a2a321ba51510b946692d3e011c1 Mon Sep 17 00:00:00 2001 From: snow Date: Tue, 25 Apr 2023 09:47:56 +0800 Subject: [PATCH] docs: remove file number --- docs/.vitepress/config.ts | 60 +++++++++---------- ...-delete-update.md => add-delete-update.md} | 0 docs/zh/base/{02-query.md => query.md} | 0 .../{03-querywrapper.md => querywrapper.md} | 0 docs/zh/core/{09-audit.md => audit.md} | 0 docs/zh/core/{03-column.md => column.md} | 6 +- .../{15-columns-dict.md => columns-dict.md} | 2 +- ...-columns-encrypt.md => columns-encrypt.md} | 2 +- ...ns-permission.md => columns-permission.md} | 2 +- docs/zh/core/{04-db-row.md => db-row.md} | 0 .../{16-enum-property.md => enum-property.md} | 0 docs/zh/core/{07-fill.md => fill.md} | 0 docs/zh/core/{02-id.md => id.md} | 0 .../{05-logic-delete.md => logic-delete.md} | 0 docs/zh/core/{08-mask.md => mask.md} | 0 ...ulti-datasource.md => multi-datasource.md} | 0 .../{17-multi-tenancy.md => multi-tenancy.md} | 0 .../zh/core/{10-sql-print.md => sql-print.md} | 0 docs/zh/core/{01-table.md => table.md} | 0 docs/zh/core/{12-tx.md => tx.md} | 0 docs/zh/core/{06-version.md => version.md} | 0 docs/zh/faq.md | 4 +- .../{05-benchmark.md => benchmark.md} | 2 +- .../{04-comparison.md => comparison.md} | 2 +- ...-getting-started.md => getting-started.md} | 4 +- .../zh/introduction/{03-maven.md => maven.md} | 0 .../{08-qq-group.md => qq-group.md} | 0 ...upport-database.md => support-database.md} | 0 ...ybatis-native.md => use-mybatis-native.md} | 0 ...-mybatisflex.md => what-is-mybatisflex.md} | 0 docs/zh/others/{02-apt.md => apt.md} | 0 docs/zh/others/{01-codegen.md => codegen.md} | 2 +- readme_zh.md | 6 +- 33 files changed, 46 insertions(+), 46 deletions(-) rename docs/zh/base/{01-add-delete-update.md => add-delete-update.md} (100%) rename docs/zh/base/{02-query.md => query.md} (100%) rename docs/zh/base/{03-querywrapper.md => querywrapper.md} (100%) rename docs/zh/core/{09-audit.md => audit.md} (100%) rename docs/zh/core/{03-column.md => column.md} (97%) rename docs/zh/core/{15-columns-dict.md => columns-dict.md} (96%) rename docs/zh/core/{14-columns-encrypt.md => columns-encrypt.md} (93%) rename docs/zh/core/{13-columns-permission.md => columns-permission.md} (96%) rename docs/zh/core/{04-db-row.md => db-row.md} (100%) rename docs/zh/core/{16-enum-property.md => enum-property.md} (100%) rename docs/zh/core/{07-fill.md => fill.md} (100%) rename docs/zh/core/{02-id.md => id.md} (100%) rename docs/zh/core/{05-logic-delete.md => logic-delete.md} (100%) rename docs/zh/core/{08-mask.md => mask.md} (100%) rename docs/zh/core/{11-multi-datasource.md => multi-datasource.md} (100%) rename docs/zh/core/{17-multi-tenancy.md => multi-tenancy.md} (100%) rename docs/zh/core/{10-sql-print.md => sql-print.md} (100%) rename docs/zh/core/{01-table.md => table.md} (100%) rename docs/zh/core/{12-tx.md => tx.md} (100%) rename docs/zh/core/{06-version.md => version.md} (100%) rename docs/zh/introduction/{05-benchmark.md => benchmark.md} (99%) rename docs/zh/introduction/{04-comparison.md => comparison.md} (99%) rename docs/zh/introduction/{02-getting-started.md => getting-started.md} (97%) rename docs/zh/introduction/{03-maven.md => maven.md} (100%) rename docs/zh/introduction/{08-qq-group.md => qq-group.md} (100%) rename docs/zh/introduction/{07-support-database.md => support-database.md} (100%) rename docs/zh/introduction/{06-use-mybatis-native.md => use-mybatis-native.md} (100%) rename docs/zh/introduction/{01-what-is-mybatisflex.md => what-is-mybatisflex.md} (100%) rename docs/zh/others/{02-apt.md => apt.md} (100%) rename docs/zh/others/{01-codegen.md => codegen.md} (99%) diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 255d157f..e301a139 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -33,51 +33,51 @@ export default defineConfig({ { text: '简介', items: [ - {text: 'Mybatis-Flex 是什么', link: '/zh/introduction/01-what-is-mybatisflex'}, - {text: '快速开始', link: '/zh/introduction/02-getting-started'}, - {text: 'Maven 依赖', link: '/zh/introduction/03-maven'}, - {text: '和同类框架「功能」对比', link: '/zh/introduction/04-comparison'}, - {text: '和同类框架「性能」对比', link: '/zh/introduction/05-benchmark'}, - {text: '使用 Mybatis 原生功能', link: '/zh/introduction/06-use-mybatis-native'}, - {text: '支持的数据库类型', link: '/zh/introduction/07-support-database'}, - {text: 'QQ 交流群', link: '/zh/introduction/08-qq-group'}, + {text: 'Mybatis-Flex 是什么', link: '/zh/introduction/what-is-mybatisflex'}, + {text: '快速开始', link: '/zh/introduction/getting-started'}, + {text: 'Maven 依赖', link: '/zh/introduction/maven'}, + {text: '和同类框架「功能」对比', link: '/zh/introduction/comparison'}, + {text: '和同类框架「性能」对比', link: '/zh/introduction/benchmark'}, + {text: '使用 Mybatis 原生功能', link: '/zh/introduction/use-mybatis-native'}, + {text: '支持的数据库类型', link: '/zh/introduction/support-database'}, + {text: 'QQ 交流群', link: '/zh/introduction/qq-group'}, ] }, { text: '基础功能', items: [ - {text: '增删改', link: '/zh/base/01-add-delete-update'}, - {text: '查询和分页', link: '/zh/base/02-query'}, - {text: 'QueryWrapper', link: '/zh/base/03-querywrapper'}, + {text: '增删改', link: '/zh/base/add-delete-update'}, + {text: '查询和分页', link: '/zh/base/query'}, + {text: 'QueryWrapper', link: '/zh/base/querywrapper'}, ] }, { text: '核心功能', items: [ - {text: '@Table 注解', link: '/zh/core/01-table'}, - {text: '@Id 注解', link: '/zh/core/02-id'}, - {text: '@Column 注解', link: '/zh/core/03-column'}, - {text: 'Db + Row', link: '/zh/core/04-db-row'}, - {text: '逻辑删除', link: '/zh/core/05-logic-delete'}, - {text: '乐观锁', link: '/zh/core/06-version'}, - {text: '数据填充', link: '/zh/core/07-fill'}, - {text: '数据脱敏', link: '/zh/core/08-mask'}, - {text: 'SQL 审计', link: '/zh/core/09-audit'}, - {text: 'SQL 打印', link: '/zh/core/10-sql-print'}, - {text: '多数据源', link: '/zh/core/11-multi-datasource'}, - {text: '事务管理', link: '/zh/core/12-tx'}, - {text: '字段权限', link: '/zh/core/13-columns-permission'}, - {text: '字段加密', link: '/zh/core/14-columns-encrypt'}, - {text: '字典回写', link: '/zh/core/15-columns-dict'}, - {text: '枚举属性', link: '/zh/core/16-enum-property'}, - {text: '多租户', link: '/zh/core/17-multi-tenancy'}, + {text: '@Table 注解', link: '/zh/core/table'}, + {text: '@Id 注解', link: '/zh/core/id'}, + {text: '@Column 注解', link: '/zh/core/column'}, + {text: 'Db + Row', link: '/zh/core/db-row'}, + {text: '逻辑删除', link: '/zh/core/logic-delete'}, + {text: '乐观锁', link: '/zh/core/version'}, + {text: '数据填充', link: '/zh/core/fill'}, + {text: '数据脱敏', link: '/zh/core/mask'}, + {text: 'SQL 审计', link: '/zh/core/audit'}, + {text: 'SQL 打印', link: '/zh/core/sql-print'}, + {text: '多数据源', link: '/zh/core/multi-datasource'}, + {text: '事务管理', link: '/zh/core/tx'}, + {text: '字段权限', link: '/zh/core/columns-permission'}, + {text: '字段加密', link: '/zh/core/columns-encrypt'}, + {text: '字典回写', link: '/zh/core/columns-dict'}, + {text: '枚举属性', link: '/zh/core/enum-property'}, + {text: '多租户', link: '/zh/core/multi-tenancy'}, ] }, { text: '其他', items: [ - {text: '代码生成器', link: '/zh/others/01-codegen'}, - {text: 'APT 设置', link: '/zh/others/02-apt'}, + {text: '代码生成器', link: '/zh/others/codegen'}, + {text: 'APT 设置', link: '/zh/others/apt'}, ] } ], diff --git a/docs/zh/base/01-add-delete-update.md b/docs/zh/base/add-delete-update.md similarity index 100% rename from docs/zh/base/01-add-delete-update.md rename to docs/zh/base/add-delete-update.md diff --git a/docs/zh/base/02-query.md b/docs/zh/base/query.md similarity index 100% rename from docs/zh/base/02-query.md rename to docs/zh/base/query.md diff --git a/docs/zh/base/03-querywrapper.md b/docs/zh/base/querywrapper.md similarity index 100% rename from docs/zh/base/03-querywrapper.md rename to docs/zh/base/querywrapper.md diff --git a/docs/zh/core/09-audit.md b/docs/zh/core/audit.md similarity index 100% rename from docs/zh/core/09-audit.md rename to docs/zh/core/audit.md diff --git a/docs/zh/core/03-column.md b/docs/zh/core/column.md similarity index 97% rename from docs/zh/core/03-column.md rename to docs/zh/core/column.md index f70ab469..a99c2830 100644 --- a/docs/zh/core/03-column.md +++ b/docs/zh/core/column.md @@ -195,11 +195,11 @@ QueryWrapper.create() ## isLogicDelete -这部分的文档参考 [逻辑删除章节](./05-logic-delete.md)。 +这部分的文档参考 [逻辑删除章节](./logic-delete.md)。 ## version -这部分的文档参考 [乐观锁章节](./06-version.md)。 +这部分的文档参考 [乐观锁章节](./version.md)。 ## typeHandler @@ -276,4 +276,4 @@ mybatis-flex 内置的扩展 typeHandler 还有: 在某些场景下,我们的 entity 可能会有通用的字段以及配置,这种场景如果我们要为每个 entity 去设置,这会相对麻烦。 在这种场景下,我们可以建立一个通用的 BaseEntity 类,然后让所有的 Entity 都继承是该类。 -Entity 一般是通过代码生成器生成的,我们通过 `GlobalConfig.entitySupperClass` 可以为代码生成器配置全局的 Entity 父类,更多关于代码生成器可以请访问 [这里](../others/01-codegen.md)。 \ No newline at end of file +Entity 一般是通过代码生成器生成的,我们通过 `GlobalConfig.entitySupperClass` 可以为代码生成器配置全局的 Entity 父类,更多关于代码生成器可以请访问 [这里](../others/codegen.md)。 \ No newline at end of file diff --git a/docs/zh/core/15-columns-dict.md b/docs/zh/core/columns-dict.md similarity index 96% rename from docs/zh/core/15-columns-dict.md rename to docs/zh/core/columns-dict.md index 13609ea2..90bb6f5a 100644 --- a/docs/zh/core/15-columns-dict.md +++ b/docs/zh/core/columns-dict.md @@ -47,4 +47,4 @@ public class Account { } ``` -更多的 `onSet` 还可以参考 [这里](./01-table.md)。 \ No newline at end of file +更多的 `onSet` 还可以参考 [这里](./table.md)。 \ No newline at end of file diff --git a/docs/zh/core/14-columns-encrypt.md b/docs/zh/core/columns-encrypt.md similarity index 93% rename from docs/zh/core/14-columns-encrypt.md rename to docs/zh/core/columns-encrypt.md index 14d1e7ab..271a709a 100644 --- a/docs/zh/core/14-columns-encrypt.md +++ b/docs/zh/core/columns-encrypt.md @@ -38,4 +38,4 @@ public class Account { } ``` -更多的 `onSet` 还可以参考 [这里](./01-table.md)。 \ No newline at end of file +更多的 `onSet` 还可以参考 [这里](./table.md)。 \ No newline at end of file diff --git a/docs/zh/core/13-columns-permission.md b/docs/zh/core/columns-permission.md similarity index 96% rename from docs/zh/core/13-columns-permission.md rename to docs/zh/core/columns-permission.md index 3a664a03..83263fd6 100644 --- a/docs/zh/core/13-columns-permission.md +++ b/docs/zh/core/columns-permission.md @@ -48,4 +48,4 @@ public class Account { } ``` -更多的 `onSet` 还可以参考 [这里](./01-table.md)。 \ No newline at end of file +更多的 `onSet` 还可以参考 [这里](./table.md)。 \ No newline at end of file diff --git a/docs/zh/core/04-db-row.md b/docs/zh/core/db-row.md similarity index 100% rename from docs/zh/core/04-db-row.md rename to docs/zh/core/db-row.md diff --git a/docs/zh/core/16-enum-property.md b/docs/zh/core/enum-property.md similarity index 100% rename from docs/zh/core/16-enum-property.md rename to docs/zh/core/enum-property.md diff --git a/docs/zh/core/07-fill.md b/docs/zh/core/fill.md similarity index 100% rename from docs/zh/core/07-fill.md rename to docs/zh/core/fill.md diff --git a/docs/zh/core/02-id.md b/docs/zh/core/id.md similarity index 100% rename from docs/zh/core/02-id.md rename to docs/zh/core/id.md diff --git a/docs/zh/core/05-logic-delete.md b/docs/zh/core/logic-delete.md similarity index 100% rename from docs/zh/core/05-logic-delete.md rename to docs/zh/core/logic-delete.md diff --git a/docs/zh/core/08-mask.md b/docs/zh/core/mask.md similarity index 100% rename from docs/zh/core/08-mask.md rename to docs/zh/core/mask.md diff --git a/docs/zh/core/11-multi-datasource.md b/docs/zh/core/multi-datasource.md similarity index 100% rename from docs/zh/core/11-multi-datasource.md rename to docs/zh/core/multi-datasource.md diff --git a/docs/zh/core/17-multi-tenancy.md b/docs/zh/core/multi-tenancy.md similarity index 100% rename from docs/zh/core/17-multi-tenancy.md rename to docs/zh/core/multi-tenancy.md diff --git a/docs/zh/core/10-sql-print.md b/docs/zh/core/sql-print.md similarity index 100% rename from docs/zh/core/10-sql-print.md rename to docs/zh/core/sql-print.md diff --git a/docs/zh/core/01-table.md b/docs/zh/core/table.md similarity index 100% rename from docs/zh/core/01-table.md rename to docs/zh/core/table.md diff --git a/docs/zh/core/12-tx.md b/docs/zh/core/tx.md similarity index 100% rename from docs/zh/core/12-tx.md rename to docs/zh/core/tx.md diff --git a/docs/zh/core/06-version.md b/docs/zh/core/version.md similarity index 100% rename from docs/zh/core/06-version.md rename to docs/zh/core/version.md diff --git a/docs/zh/faq.md b/docs/zh/faq.md index 0aa59083..d63635d7 100644 --- a/docs/zh/faq.md +++ b/docs/zh/faq.md @@ -3,7 +3,7 @@ ## 示例中的 AccountMapper 和 "ACCOUNT" 在哪里,报错了。 Mybatis-Flex 使用了 APT 技术,这两个类是自动生成的。 -参考:[Mybatis-Flex APT 配置 - Mybatis-Flex 官方网站](./others/02-apt.md) +参考:[Mybatis-Flex APT 配置 - Mybatis-Flex 官方网站](./others/apt.md) @@ -76,5 +76,5 @@ spring: 的主动发现机制。若使用 `hikariCP` 数据源,则可以不配置 `type` 内容。 > 若使用多数据源,或者把数据源配置到 `mybatis-flex.datasource` 下,使用 mybatis-flex 的数据源发现机制, -> 使用 druid 也可以不用配置 type,更多文档参考:[多数据源章节](./core/11-multi-datasource.md)。 +> 使用 druid 也可以不用配置 type,更多文档参考:[多数据源章节](./core/multi-datasource.md)。 diff --git a/docs/zh/introduction/05-benchmark.md b/docs/zh/introduction/benchmark.md similarity index 99% rename from docs/zh/introduction/05-benchmark.md rename to docs/zh/introduction/benchmark.md index e28feda1..1eab062a 100644 --- a/docs/zh/introduction/05-benchmark.md +++ b/docs/zh/introduction/benchmark.md @@ -3,7 +3,7 @@ 本文主要是展示了 Mybatis-Flex 和 Mybaits-Plus 的「性能」对比。Mybaits-Plus 是一个非常优秀 Mybaits 增强框架, 其开源于 2016 年,有很多的成功案例。 -本文只阐述了「性能」方面的对比,「功能」对比请参考 [这里](./04-comparison.md)。 +本文只阐述了「性能」方面的对比,「功能」对比请参考 [这里](./comparison.md)。 ## 测试方法 使用 h2 数据库,在初始化的时候分别为 mybatis-flex 和 mybatis-plus 创建两个不同的数据库, 但是完全一样的数据结构、数据内容和数据量(每个库 2w 条数据)。 diff --git a/docs/zh/introduction/04-comparison.md b/docs/zh/introduction/comparison.md similarity index 99% rename from docs/zh/introduction/04-comparison.md rename to docs/zh/introduction/comparison.md index f7135ced..a7125c09 100644 --- a/docs/zh/introduction/04-comparison.md +++ b/docs/zh/introduction/comparison.md @@ -5,7 +5,7 @@ MyBatis-Flex 主要是和 `MyBatis-Plus` 与 `Fluent-Mybatis` 对比,内容来 - MyBatis-Plus:老牌的 MyBatis 增强框架,开源于 2016 年。 - Fluent-Mybatis:阿里云开发的 Mybatis 增强框架(来至于阿里云·云效产品团队) -> 本文只阐述了「功能」方面的对比,**「性能」** 对比请参考 [这里](./05-benchmark.md)。 +> 本文只阐述了「功能」方面的对比,**「性能」** 对比请参考 [这里](./benchmark.md)。 > 若发现对比中有错误,请加入 Mybatis-Flex QQ 交流群:532992631,然后联系群主纠正。 ## 功能对比 diff --git a/docs/zh/introduction/02-getting-started.md b/docs/zh/introduction/getting-started.md similarity index 97% rename from docs/zh/introduction/02-getting-started.md rename to docs/zh/introduction/getting-started.md index 363b7330..cb279baa 100644 --- a/docs/zh/introduction/02-getting-started.md +++ b/docs/zh/introduction/getting-started.md @@ -47,7 +47,7 @@ dependencies { **第 3 步:编写实体类和 Mapper** -> 这部分可以使用 Mybatis-Flex 的代码生成器来生成实体类哟,功能非常强大的。详情进入:[代码生成器章节](../others/01-codegen.md) 了解。 +> 这部分可以使用 Mybatis-Flex 的代码生成器来生成实体类哟,功能非常强大的。详情进入:[代码生成器章节](../others/codegen.md) 了解。 ```java @Table("tb_account") @@ -82,7 +82,7 @@ gradle中 `gradlew classes` -更多信息请参考:[APT 设置章节](*../others/02-apt.md*) +更多信息请参考:[APT 设置章节](../others/apt.md) diff --git a/docs/zh/introduction/03-maven.md b/docs/zh/introduction/maven.md similarity index 100% rename from docs/zh/introduction/03-maven.md rename to docs/zh/introduction/maven.md diff --git a/docs/zh/introduction/08-qq-group.md b/docs/zh/introduction/qq-group.md similarity index 100% rename from docs/zh/introduction/08-qq-group.md rename to docs/zh/introduction/qq-group.md diff --git a/docs/zh/introduction/07-support-database.md b/docs/zh/introduction/support-database.md similarity index 100% rename from docs/zh/introduction/07-support-database.md rename to docs/zh/introduction/support-database.md diff --git a/docs/zh/introduction/06-use-mybatis-native.md b/docs/zh/introduction/use-mybatis-native.md similarity index 100% rename from docs/zh/introduction/06-use-mybatis-native.md rename to docs/zh/introduction/use-mybatis-native.md diff --git a/docs/zh/introduction/01-what-is-mybatisflex.md b/docs/zh/introduction/what-is-mybatisflex.md similarity index 100% rename from docs/zh/introduction/01-what-is-mybatisflex.md rename to docs/zh/introduction/what-is-mybatisflex.md diff --git a/docs/zh/others/02-apt.md b/docs/zh/others/apt.md similarity index 100% rename from docs/zh/others/02-apt.md rename to docs/zh/others/apt.md diff --git a/docs/zh/others/01-codegen.md b/docs/zh/others/codegen.md similarity index 99% rename from docs/zh/others/01-codegen.md rename to docs/zh/others/codegen.md index 33891458..b3bb8af5 100644 --- a/docs/zh/others/01-codegen.md +++ b/docs/zh/others/codegen.md @@ -82,7 +82,7 @@ public class Codegen { 注意:由于 MyBatis-Flex 的 APT 功能会自动帮我们生成了 Mapper 的 Java 类,如果我们在代码生成器中选择生成 Mapper, 则建议把 APT 的 Mapper 生成功能给关闭掉,否则系统中会存在两份一样功能的 Mapper。 -关闭 APT 的 Mapper 类文件生成,请参考:[APT 设置章节](../others/02-apt.md) +关闭 APT 的 Mapper 类文件生成,请参考:[APT 设置章节](../others/apt.md) ## 全局配置 GlobalConfig diff --git a/readme_zh.md b/readme_zh.md index fff0a6bb..8e9d7dc8 100644 --- a/readme_zh.md +++ b/readme_zh.md @@ -390,7 +390,7 @@ QueryWrapper queryWrapper = QueryWrapper.create() ![](./docs/assets/images/build_idea.png) -> 更多关于 Mybatis-Flex APT 的配置,请点击 [这里](./docs/zh/others/02-apt.md)。 +> 更多关于 Mybatis-Flex APT 的配置,请点击 [这里](./docs/zh/others/apt.md)。 ## Db + Row 工具类 @@ -431,7 +431,7 @@ Page rowPage=Db.paginate("tb_account",3,10,query); > > 具体参考: [Db.java](./mybatis-flex-core/src/main/java/com/mybatisflex/core/row/Db.java) 。 > -> 更多关于 Row 插入时的**主键生成机制**、以及Db 的**事务管理**等,请点击 [这里](./docs/zh/core/04-db-row.md) 。 +> 更多关于 Row 插入时的**主键生成机制**、以及Db 的**事务管理**等,请点击 [这里](./docs/zh/core/db-row.md) 。 ## Entity 部分字段更新 @@ -575,7 +575,7 @@ public class Account { } ``` -> 更多关于主键的配置,请点击 [这里](./docs/zh/core/02-id.md) +> 更多关于主键的配置,请点击 [这里](./docs/zh/core/id.md) ## 更多文档