diff --git a/mybatis-spring-boot-autoconfigure/src/site/markdown/index.md b/mybatis-spring-boot-autoconfigure/src/site/markdown/index.md.vm
similarity index 96%
rename from mybatis-spring-boot-autoconfigure/src/site/markdown/index.md
rename to mybatis-spring-boot-autoconfigure/src/site/markdown/index.md.vm
index e3e00ea31..e1fa7f871 100644
--- a/mybatis-spring-boot-autoconfigure/src/site/markdown/index.md
+++ b/mybatis-spring-boot-autoconfigure/src/site/markdown/index.md.vm
@@ -1,6 +1,6 @@
# Introduction
-## Translations
+#[[##]]# Translations
Users can read about MyBatis-Spring-Boot-Starter in the following translations:
@@ -9,7 +9,7 @@ Users can read about MyBatis-Spring-Boot-Starter in the following translations:
简体中文
-## What is MyBatis-Spring-Boot-Starter?
+#[[##]]# What is MyBatis-Spring-Boot-Starter?
The MyBatis-Spring-Boot-Starter help you build quickly MyBatis applications on top of the [Spring Boot](https://spring.io/projects/spring-boot).
@@ -19,7 +19,7 @@ By using this module you will achieve:
* Reduce the boilerplate to almost zero
* Less XML configuration
-## Requirements
+#[[##]]# Requirements
The MyBatis-Spring-Boot-Starter requires following versions:
@@ -35,11 +35,11 @@ The MyBatis-Spring-Boot-Starter requires following versions:
| **~~1.1 (EOL)~~** | ~~1.3~~ | ~~1.3~~ | ~~6 or higher~~ |
| **~~1.0 (EOL)~~** | ~~1.2~~ | ~~1.3~~ | ~~6 or higher~~ |
-## Installation
+#[[##]]# Installation
To use the MyBatis-Spring-Boot-Starter module, you just need to include the `mybatis-spring-boot-autoconfigure.jar` file and its dependencies(`mybatis.jar`, `mybatis-spring.jar` and etc ...) in the classpath.
-### Maven
+#[[###]]# Maven
If you are using Maven just add the following dependency to your `pom.xml`:
@@ -51,7 +51,7 @@ If you are using Maven just add the following dependency to your `pom.xml`:
```
-### Gradle
+#[[###]]# Gradle
If using gradle add this to your `build.gradle`:
@@ -61,7 +61,7 @@ dependencies {
}
```
-## Quick Setup
+#[[##]]# Quick Setup
As you may already know, to use MyBatis with Spring you need at least an `SqlSessionFactory` and at least one mapper interface.
@@ -110,7 +110,7 @@ public class SampleMybatisApplication implements CommandLineRunner {
This is all you have to do. You application can now be run as a normal Spring Boot application.
-## Advanced scanning
+#[[##]]# Advanced scanning
The MyBatis-Spring-Boot-Starter will search, by default, for mappers marked with the `@Mapper` annotation.
@@ -119,7 +119,7 @@ You may want to specify a custom annotation or a marker interface for scanning.
The MyBatis-Spring-Boot-Starter will not start the scanning process if it finds at least one `MapperFactoryBean` in the Spring's context so if you want to stop the scanning at all you should register your mappers explicitly with `@Bean` methods.
-## Using an SqlSession
+#[[##]]# Using an SqlSession
An instance of a `SqlSessionTemplate` is created and added to the Spring context, so you can use the MyBatis API letting it be injected into your beans like follows(available on Spring 4.3+):
@@ -140,7 +140,7 @@ public class CityDao {
}
```
-## Configuration
+#[[##]]# Configuration
As any other Spring Boot application a MyBatis-Spring-Boot-Application configuration parameters are stored inside the `application.properties`(or `application.yml`).
@@ -191,7 +191,7 @@ mybatis:
...
```
-## Using a ConfigurationCustomizer
+#[[##]]# Using a ConfigurationCustomizer
The MyBatis-Spring-Boot-Starter provide opportunity to customize a MyBatis configuration generated by auto-configuration using Java Config.
The MyBatis-Spring-Boot-Starter will search beans that implement the `ConfigurationCustomizer` interface by automatically,
@@ -214,7 +214,7 @@ public class MyBatisConfig {
}
```
-## Using a SqlSessionFactoryBeanCustomizer
+#[[##]]# Using a SqlSessionFactoryBeanCustomizer
The MyBatis-Spring-Boot-Starter provide opportunity to customize a `SqlSessionFactoryBean` generated by auto-configuration using Java Config.
The MyBatis-Spring-Boot-Starter will search beans that implement the `SqlSessionFactoryBeanCustomizer` interface by automatically,
@@ -237,7 +237,7 @@ public class MyBatisConfig {
}
```
-## Using the SpringBootVFS
+#[[##]]# Using the SpringBootVFS
The MyBatis-Spring-Boot-Starter provides the `SpringBootVFS` as an implementation class of `VFS`.
The `VFS` is used for searching classes (e.g. target class of type alias, type handler class) from an application (or application server).
@@ -261,7 +261,7 @@ public class MyBatisConfig {
}
```
-## Detecting MyBatis components
+#[[##]]# Detecting MyBatis components
The MyBatis-Spring-Boot-Starter will detects beans that implements following interface provided by MyBatis.
@@ -300,12 +300,12 @@ public class MyBatisConfig {
NOTE: If detected `LangaugeDriver`'s count is one, it set to default scripting language automatically.
-## Customization for LanguageDriver
+#[[##]]# Customization for LanguageDriver
If you want to customize the `LanguageDriver` that creating by auto-configure,
please register user defined bean.
-### ThymeleafLanguageDriver
+#[[###]]# ThymeleafLanguageDriver
```java
@Configuration
@@ -319,7 +319,7 @@ public class MyBatisConfig {
}
```
-### FreeMarkerLanguageDriverConfig
+#[[###]]# FreeMarkerLanguageDriverConfig
```java
@Configuration
@@ -333,7 +333,7 @@ public class MyBatisConfig {
}
```
-### VelocityLanguageDriver
+#[[###]]# VelocityLanguageDriver
```java
@Configuration
@@ -347,7 +347,7 @@ public class MyBatisConfig {
}
```
-### Running Samples
+#[[###]]# Running Samples
The project provides two samples so you play and experiment with them:
diff --git a/mybatis-spring-boot-autoconfigure/src/site/zh/markdown/index.md b/mybatis-spring-boot-autoconfigure/src/site/zh/markdown/index.md.vm
similarity index 97%
rename from mybatis-spring-boot-autoconfigure/src/site/zh/markdown/index.md
rename to mybatis-spring-boot-autoconfigure/src/site/zh/markdown/index.md.vm
index 280ac91d9..85e234e41 100644
--- a/mybatis-spring-boot-autoconfigure/src/site/zh/markdown/index.md
+++ b/mybatis-spring-boot-autoconfigure/src/site/zh/markdown/index.md.vm
@@ -1,6 +1,6 @@
# 简介
-## 文档的翻译版本
+#[[##]]# 文档的翻译版本
可以阅读 MyBatis-Spring-Boot-Starter 文档的以下翻译版本:
@@ -9,7 +9,7 @@
简体中文
-## 什么是 MyBatis-Spring-Boot-Starter?
+#[[##]]# 什么是 MyBatis-Spring-Boot-Starter?
MyBatis-Spring-Boot-Starter 可以帮助你更快地在 [Spring Boot](https://spring.io/projects/spring-boot) 之上构建 MyBatis 应用。
@@ -19,7 +19,7 @@ MyBatis-Spring-Boot-Starter 可以帮助你更快地在 [Spring Boot](https://sp
* 将几乎不需要样板配置
* 使用更少的 XML 配置
-## 要求
+#[[##]]# 要求
MyBatis-Spring-Boot-Starter 要求以下版本:
@@ -35,11 +35,11 @@ MyBatis-Spring-Boot-Starter 要求以下版本:
| **~~1.1 (EOL)~~** | ~~1.3~~ | ~~1.3~~ | ~~6 或更高~~ |
| **~~1.0 (EOL)~~** | ~~1.2~~ | ~~1.3~~ | ~~6 或更高~~ |
-## 安装
+#[[##]]# 安装
要使用 MyBatis-Spring-Boot-Starter 模块,你只需要将 `mybatis-spring-boot-autoconfigure.jar` 文件以及它的依赖( `mybatis.jar`, `mybatis-spring.jar` 等) 放在类路径下。
-### Maven
+#[[###]]# Maven
如果你使用 Maven,只需要在你的 `pom.xml` 添加以下依赖:
@@ -51,7 +51,7 @@ MyBatis-Spring-Boot-Starter 要求以下版本:
```
-### Gradle
+#[[###]]# Gradle
如果使用 gradle,请在你的 `build.gradle` 中加入以下内容:
@@ -61,7 +61,7 @@ dependencies {
}
```
-## 快速开始
+#[[##]]# 快速开始
正如你已经知道的, 要与 Spring 一起使用 MyBatis,你至少需要一个 `SqlSessionFactory` 和一个 mapper 接口。
@@ -110,7 +110,7 @@ public class SampleMybatisApplication implements CommandLineRunner {
这就是你需要做的所有事情了。 你的 Spring boot 应用可以正常运行了。
-## “扫描”的进阶用法
+#[[##]]# “扫描”的进阶用法
MyBatis-Spring-Boot-Starter 将默认搜寻带有 `@Mapper` 注解的 mapper 接口。
@@ -118,7 +118,7 @@ public class SampleMybatisApplication implements CommandLineRunner {
如果 MyBatis-Spring-Boot-Starter 发现至少有一个 `SqlSessionFactoryBean` ,它将不会开始扫描。 所以如果你想停止扫描,你应该用 `@Bean` 方法明确注册你的 mapper。
-## 使用 SqlSession
+#[[##]]# 使用 SqlSession
一个 `SqlSessionTemplate` 的实例被创建并添加到 Spring 的环境中,因此你可以使用 MyBatis API,让它像下面一样被注入到你的 bean 中(Spring 4.3 以上可用)。
@@ -139,7 +139,7 @@ public class CityDao {
}
```
-## 配置
+#[[##]]# 配置
像其他的 Spring Boot 应用一样,配置参数在 `application.properties` (或 `application.yml` )。
@@ -190,7 +190,7 @@ mybatis:
...
```
-## 使用 ConfigurationCustomizer
+#[[##]]# 使用 ConfigurationCustomizer
MyBatis-Spring-Boot-Starter 提供了使用 Java Config 来自定义 MyBatis 配置的可能。
@@ -213,7 +213,7 @@ public class MyBatisConfig {
}
```
-## 使用 SqlSessionFactoryBeanCustomizer
+#[[##]]# 使用 SqlSessionFactoryBeanCustomizer
MyBatis-Spring-Boot-Starter 提供了使用 Java Config 来自定义自动配置生成的 `SqlSessionFactoryBean` 。
@@ -236,7 +236,7 @@ public class MyBatisConfig {
}
```
-## 使用 SpringBootVFS
+#[[##]]# 使用 SpringBootVFS
MyBatis-Spring-Boot-Starter 提供了 `SpringBootVFS` 作为 `VFS` 的实现类。
`VFS` 用于从应用或应用服务器中寻找类 (例如: 类型别名的目标类,类型处理器类) 。
@@ -260,7 +260,7 @@ public class MyBatisConfig {
}
```
-## 探测 MyBatis 组件
+#[[##]]# 探测 MyBatis 组件
The MyBatis-Spring-Boot-Starter 将检测实现以下由 MyBatis 提供的接口的组件。
@@ -301,7 +301,7 @@ public class MyBatisConfig {
如果你想自定义 `LangaugeDriver` 的配置,请注册用户定义的组件。
-### ThymeleafLanguageDriver
+#[[###]]# ThymeleafLanguageDriver
```java
@Configuration
@@ -315,7 +315,7 @@ public class MyBatisConfig {
}
```
-### FreeMarkerLanguageDriverConfig
+#[[###]]# FreeMarkerLanguageDriverConfig
```java
@Configuration
@@ -329,7 +329,7 @@ public class MyBatisConfig {
}
```
-### VelocityLanguageDriver
+#[[###]]# VelocityLanguageDriver
```java
@Configuration
@@ -343,7 +343,7 @@ public class MyBatisConfig {
}
```
-### 可以运行的样例
+#[[###]]# 可以运行的样例
项目(为每个分类)提供了至少两个样例,可以为你所用。
diff --git a/pom.xml b/pom.xml
index 9ddceafed..cbf714805 100644
--- a/pom.xml
+++ b/pom.xml
@@ -91,11 +91,6 @@
${project.basedir}/src/main/resources
true
-
- ${project.basedir}/src/site
- ${project.build.directory}/site-src
- true
-
@@ -104,8 +99,6 @@
maven-site-plugin
en,zh_CN
-
- ${project.build.directory}/site-src