From b0b3bcc1884784d700509a205157afe1ced87e32 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BC=80=E6=BA=90=E6=B5=B7=E5=93=A5?= Date: Fri, 12 May 2023 09:17:38 +0800 Subject: [PATCH] update docs --- docs/.vitepress/config.ts | 26 ++++++++++++++------------ docs/index.md | 10 +++++----- docs/zh/intro/getting-started.md | 2 +- docs/zh/intro/support-database.md | 2 +- readme.md | 4 ++-- readme_zh.md | 2 +- 6 files changed, 24 insertions(+), 22 deletions(-) diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 397957ee..6eb7459f 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -3,9 +3,9 @@ import {defineConfig} from 'vitepress' // https://vitepress.dev/reference/site-config export default defineConfig({ lang: 'zh-CN', - title: "Mybatis-Flex", - titleTemplate: ':title - Mybatis-Flex 官方网站', - description: "一个优雅的 Mybatis 增强框架", + title: "MyBatis-Flex", + titleTemplate: ':title - MyBatis-Flex 官方网站', + description: "一个优雅的 MyBatis 增强框架", lastUpdated: true, // logo: '/assets/images/logo02.png', @@ -24,17 +24,19 @@ export default defineConfig({ nav: [ {text: '首页', link: '/'}, {text: '帮助文档', link: '/zh/intro/what-is-mybatisflex'}, - {text: '常见问题', link: '/zh/faq'}, - { - text: '周边', items: [ - {text: '示例代码', link: 'https://gitee.com/mybatis-flex/mybatis-flex-samples'}, - {text: '更新日志', link: 'https://gitee.com/mybatis-flex/mybatis-flex/releases'}, - ] - }, + {text: '🔥常见问题', link: '/zh/faq'}, + // { + // text: '周边', items: [ + // {text: '示例代码', link: 'https://gitee.com/mybatis-flex/mybatis-flex-samples'}, + // {text: '更新日志', link: 'https://gitee.com/mybatis-flex/mybatis-flex/releases'}, + // ] + // }, { text: '获取源码', items: [ {text: 'Gitee', link: 'https://gitee.com/mybatis-flex/mybatis-flex'}, - {text: 'Github', link: 'https://github.com/mybatis-flex/mybatis-flex'} + {text: 'Github', link: 'https://github.com/mybatis-flex/mybatis-flex'}, + {text: '示例代码', link: 'https://gitee.com/mybatis-flex/mybatis-flex-samples'}, + {text: '性能测试代码', link: 'https://gitee.com/mybatis-flex/mybatis-benchmark'}, ] }, ], @@ -43,7 +45,7 @@ export default defineConfig({ { text: '简介', items: [ - {text: 'Mybatis-Flex 是什么', link: '/zh/intro/what-is-mybatisflex'}, + {text: 'MyBatis-Flex 是什么', link: '/zh/intro/what-is-mybatisflex'}, {text: '快速开始', link: '/zh/intro/getting-started'}, {text: 'Maven 依赖', link: '/zh/intro/maven'}, {text: '和同类框架「功能」对比', link: '/zh/intro/comparison'}, diff --git a/docs/index.md b/docs/index.md index cc7657ef..e955f366 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,8 +2,8 @@ layout: home hero: - name: "Mybatis-Flex" - text: "一个优雅的 Mybatis 增强框架" + name: "MyBatis-Flex" + text: "一个优雅的 MyBatis 增强框架" tagline: 更轻量、更灵活、以及更高的性能。 image: src: /assets/images/logo01.png @@ -18,10 +18,10 @@ hero: features: - title: 更轻量 - details: Mybatis-Flex 除了 Mybatis 本身，再无任何第三方依赖，因此会带来更高的自主性、把控性和稳定性。在任何一个系统中，依赖越多，稳定性越差。 + details: MyBatis-Flex 除了 MyBatis 本身，再无任何第三方依赖，因此会带来更高的自主性、把控性和稳定性。在任何一个系统中，依赖越多，稳定性越差。 - title: 更灵活 - details: Mybatis-Flex 提供了非常灵活的 QueryWrapper，支持关联查询、多表查询、多主键、逻辑删除、乐观锁更新、数据填充、数据脱敏、等等.... + details: MyBatis-Flex 提供了非常灵活的 QueryWrapper，支持关联查询、多表查询、多主键、逻辑删除、乐观锁更新、数据填充、数据脱敏、等等.... - title: 更高的性能 - details: Mybatis-Flex 通过独特的架构，没有任何 Mybatis 拦截器、在 SQL 执行的过程中，没有任何的 Sql Parse，因此会带来指数级的性能增长。 + details: MyBatis-Flex 通过独特的架构，没有任何 Mybatis 拦截器、在 SQL 执行的过程中，没有任何的 Sql Parse，因此会带来指数级的性能增长。 --- diff --git a/docs/zh/intro/getting-started.md b/docs/zh/intro/getting-started.md index 72dc8127..2870f0a4 100644 --- a/docs/zh/intro/getting-started.md +++ b/docs/zh/intro/getting-started.md @@ -3,7 +3,7 @@ 在开始之前，我们假定您已经： - 熟悉 Java 环境配置及其开发 -- 熟悉 关系型 数据库，比如 MySql +- 熟悉 关系型 数据库，比如 MySQL ## Hello World diff --git a/docs/zh/intro/support-database.md b/docs/zh/intro/support-database.md index 3f3b572a..c7380e16 100644 --- a/docs/zh/intro/support-database.md +++ b/docs/zh/intro/support-database.md @@ -5,7 +5,7 @@ Mybatis-Flex 支持的数据库类型，如下表格所示，我们还可以通 | 数据库 | 描述 | | -------- | -------- | -| mysql | MySql 数据库 | +| mysql | MySQL 数据库 | | mariadb | MariaDB 数据库 | | oracle | Oracle11g 及以下数据库 | | oracle12c | Oracle12c 及以上数据库 | diff --git a/readme.md b/readme.md index 9d25485f..4c6176fe 100644 --- a/readme.md +++ b/readme.md @@ -1,10 +1,10 @@ ![](./docs/assets/images/logo_en.png) -# Mybatis-Flex is an elegant Mybatis Enhancement Framework. +# MyBatis-Flex is an elegant Mybatis Enhancement Framework. ## Features -- 1、Mybatis-Flex is very lightweight, and it only depends on Mybatis and no other third-party dependencies +- 1、MyBatis-Flex is very lightweight, and it only depends on Mybatis and no other third-party dependencies - 2、Basic CRUD operator and paging query of Entity class - 3、Row mapping support, you can add, delete, modify and query the database without entity classes - 4、Support multiple databases, and expand through dialects flexibly. diff --git a/readme_zh.md b/readme_zh.md index d63abe6c..0eb8ed8a 100644 --- a/readme_zh.md +++ b/readme_zh.md @@ -1,7 +1,7 @@ ![](./docs/assets/images/logo.png) -# Mybatis-Flex： 更灵活、更轻量、更好用 +# MyBatis-Flex： 更灵活、更轻量、更好用 ## 特征