admin/mybatis-flex
1
0
Fork 0
mirror of https://gitee.com/mybatis-flex/mybatis-flex.git synced 2025-12-08 01:28:24 +08:00
Code Issues Packages Projects Releases Wiki Activity

doc: update docs

Browse Source
This commit is contained in:
开源海哥 2023-09-04 15:24:41 +08:00
parent ba2b8a0900
commit 5bb2af4489
5 changed files with 106 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/.vitepress/config.ts
View File

@ -28,7 +28,6 @@ export default defineConfig({
{text: '帮助文档', link: '/zh/intro/what-is-mybatisflex'}, {text: '帮助文档', link: '/zh/intro/what-is-mybatisflex'},
{text: '🆘 常见问题', link: '/zh/faq'}, {text: '🆘 常见问题', link: '/zh/faq'},
{text: '周边 / 视频教程', link: '/zh/awesome-things'}, {text: '周边 / 视频教程', link: '/zh/awesome-things'},
// {text: '周边', link: '/zh/awesome-things'},
{text: 'ChangeLog', link: '/zh/changes'}, {text: 'ChangeLog', link: '/zh/changes'},
{ {
text: '获取源码', items: [ text: '获取源码', items: [
@ -36,6 +35,7 @@ export default defineConfig({
{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-flex-samples'},
{text: '性能测试代码', link: 'https://gitee.com/mybatis-flex/mybatis-benchmark'}, {text: '性能测试代码', link: 'https://gitee.com/mybatis-flex/mybatis-benchmark'},
{text: 'MyBatis-Flex-Admin', link: 'https://gitee.com/mybatis-flex/mybatis-flex-admin'},
] ]
}, },
], ],

161
docs/.vitepress/theme/MyLayout.vue
View File

@ -24,107 +24,110 @@ const {Layout} = DefaultTheme
<style> <style>
.ad { .ad {
margin-top: 20px; margin-top: 20px;
} }
.ad > .title { .ad > .title {
text-align: center; text-align: center;
} }
.ad > .title a { .ad > .title a {
color: #82AAFF; color: #82AAFF;
font-size: 14px; font-size: 14px;
} }
.ad > .content { .ad > .content {
display: flex; display: flex;
flex-wrap: wrap; flex-wrap: wrap;
align-items: flex-start; align-items: flex-start;
} }
.ad .banner { .ad .banner {
width: 105px; width: 105px;
margin: 1px; margin: 1px;
height: 50px; height: 50px;
font-size: 14px; font-size: 14px;
line-height: 50px; line-height: 50px;
background: #f7f7f7; background: #f7f7f7;
border-radius: 3px; border-radius: 3px;
text-align: center; text-align: center;
color: #666; color: #666;
} }
.ad .banner a{
display: inline-block; .ad .banner a {
vertical-align: middle; display: inline-block;
vertical-align: middle;
} }
.banner-bottom { .banner-bottom {
width: 212px; width: 212px;
margin: 1px; margin: 1px;
height: 50px; height: 50px;
font-size: 14px; font-size: 14px;
line-height: 50px; line-height: 50px;
background: #f7f7f7; background: #f7f7f7;
text-align: center; text-align: center;
color: #666; color: #666;
} }
</style> </style>
<template> <template>
<Layout> <Layout>
<!--docs: https://vitepress.dev/guide/extending-default-theme#layout-slots--> <!--docs: https://vitepress.dev/guide/extending-default-theme#layout-slots-->
<template #doc-footer-before> <template #doc-footer-before>
<div class="info custom-block" style="margin-bottom: 14px"> <div class="info custom-block" style="margin-bottom: 14px">
<!-- <p class="custom-block-title">对这篇文章还有疑问？</p>--> <!-- <p class="custom-block-title">对这篇文章还有疑问？</p>-->
<p>对这篇文章还有疑问？ 点击 <a href="https://gitee.com/mybatis-flex/mybatis-flex/issues/new" target="_blank">[这里]</a> 发起提问。 <p>对这篇文章还有疑问？ 点击 <a href="https://gitee.com/mybatis-flex/mybatis-flex/issues/new"
</p> target="_blank">[这里]</a> 发起提问。
</div> </p>
</template>
<template #aside-outline-after>
<div class="ad">
<div class="title">
<a href="/zh/becoming-a-sponsor.html">成为赞助者</a>
</div>
<div class="content">
<div class="banner">
<a href="https://dromara.gitee.io/fast-request/" target="_blank"><img src="/assets/images/ad/fast-request-20230828.svg" style="width: 120px;height: 50px"></a>
</div> </div>
<div class="banner"> </template>
<a href="http://www.jpress.cn" target="_blank" style="height:50px;
<template #aside-outline-after>
<div class="ad">
<div class="title">
<a href="/zh/becoming-a-sponsor.html">成为赞助者</a>
</div>
<div class="content">
<div class="banner">
<a href="https://dromara.gitee.io/fast-request/" target="_blank"><img
src="/assets/images/ad/fast-request-20230828.svg" style="width: 120px;height: 50px"></a>
</div>
<div class="banner">
<a href="http://www.jpress.cn" target="_blank" style="height:50px;
background: rgb(247 247 247);width: 105px;color: #000;font-size: 18px"> background: rgb(247 247 247);width: 105px;color: #000;font-size: 18px">
信创 CMS 信创 CMS
</a> </a>
</div> </div>
<div class="banner"> <div class="banner">
<a href="https://lyunai.top" target="_blank"><img src="/assets/images/ad/lyunai_20230827.png" style="width: 105px;height: 50px"></a> <a href="http://www.haorentech.com" target="_blank"><img
</div> src="/assets/images/ad/haorentech_20230901.png" style="width: 105px;height: 50px"></a>
<div class="banner"> </div>
<a href="https://aigc.zijiantty.com" target="_blank"><img src="/assets/images/ad/zijiantty_20230827.png" style="width: 105px;height: 50px"></a> <div class="banner">
</div> <a href="http://www.codeformat.cn" target="_blank"><img src="/assets/images/ad/code-format.png"></a>
<div class="banner"> </div>
<a href="http://www.haorentech.com" target="_blank"><img src="/assets/images/ad/haorentech_20230901.png" style="width: 105px;height: 50px"></a> <div class="banner">
<a href="https://gitee.com/sdyunze/iotlink" target="_blank"><img
src="/assets/images/ad/iotlink_20240802.png"></a>
</div>
<div class="banner">
<a href="https://eiam.topiam.cn" target="_blank"><img
src="/assets/images/ad/topiam_20230909.png" style="width: 105px;height: 50px"></a>
</div>
<div class="banner">
虚以待位
</div>
<div class="banner">
虚以待位
</div>
</div>
<div class="banner-bottom">
虚以待位
</div>
</div> </div>
<div class="banner"> </template>
<a href="http://www.codeformat.cn" target="_blank"><img src="/assets/images/ad/code-format.png"></a> </Layout>
</div>
<div class="banner">
<a href="https://gitee.com/sdyunze/iotlink" target="_blank"><img src="/assets/images/ad/iotlink_20240802.png"></a>
</div>
<div class="banner">
<a href="https://eiam.topiam.cn" target="_blank"><img src="/assets/images/ad/topiam_20230909.png" style="width: 105px;height: 50px"></a>
</div>
</div>
<div class="banner-bottom">
<a href="https://www.west.cn/ykj/view.asp?domain=springboot.net" target="_blank" style="height:50px;
background: rgb(247 247 247);width: 105px;color: #000;font-size: 18px">
springboot.net 域名出售
</a>
</div>
</div>
</template>
</Layout>
</template> </template>

BIN
docs/assets/images/mybatis-flex-admin.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 137 KiB

8
docs/zh/awesome-things.md
View File

@ -126,4 +126,12 @@ https://www.bilibili.com/video/BV1kF411r7ky
![](../assets/images/mybatis-flex-helper/04.png) ![](../assets/images/mybatis-flex-helper/04.png)
## MyBatis-Flex-Admin
![](../assets/images/mybatis-flex-admin.png)
**MyBatis-Flex-Admin** 是一个基于 MyBatis-Flex 开发的 SQL 执行日志平台和 SQL 审计平台，整个项目只有 5 张表，也是一个绝佳的 MyBatis-Flex 学习项目。
该项目使用前后端分离的方式，后端使用 SpringBoot 2.x + MyBatis-Flex，前台有 React 和 Vue 两个版本，开源地址（当前正在开发中）：
https://gitee.com/mybatis-flex/mybatis-flex-admin

15
docs/zh/base/configuration.md
View File

@ -156,6 +156,8 @@ TypeHandler 扫描路径，如果配置了该属性，SqlSessionFactoryBean 会
## admin-config ## admin-config
通过对 admin-config 的配置，可以把当前应用执行的 SQL，发送到 **MyBatis-Flex-Admin** 进行审计，详情点击 [这里](/zh/awesome-things.html#mybatis-flex-admin)。
### enable ### enable
- 类型：`boolean` - 类型：`boolean`
@ -177,6 +179,19 @@ MyBatis-Flex-Admin 连接端点。
MyBatis-Flex-Admin 连接密钥。 MyBatis-Flex-Admin 连接密钥。
---
示例代码：
```yaml
mybatis-flex:
admin-config:
enable: true
endpoint: http://admin-host:8080/message/collect
secret-key: secretKey
```
> secret-key 配置的内容，必须要和 MyBatis-Flex-Admin 项目配置的 `mybatis-flex.admin.message-secret-key` 完全一致，才能正常收集 SQL 执行日志。
## seata-config ## seata-config
### enable ### enable