# jimmer-doc

**Repository Path**: mayihua/jimmer-doc

## Basic Information

- **Project Name**: jimmer-doc
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-01-27
- **Last Updated**: 2024-01-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Jimmer 社区文档

旨在提供相对简单的上手 Jimmer 框架的途径。

## Git 仓库地址

[Gitee](https://gitee.com/run-around---whats-wrong/jimmer-community-doc)

## 项目规范

### 项目示例

所有的项目均保持单模块，工程命名按照实际业务命名，不对应文章。

尽可能保持单个演示项目中的实体不超过五个。

演示项目技术栈基本使用 Java + Maven + SpringBoot + H2，直接使用 IDEA 中的 Spring Initializer 进行创建，应用使用默认版本。

演示代码基本使用 Java 进行演示，SQL 演示考虑目前国内的用户数量基本使用 MySQL 方言，暂时不考虑语法兼容性。

### 图片路径

图片统一放置在 [images](docs/images) 这个目录下，按照对应文章的文件名和路径创建对应的文件。

图片不进行复用和交叉引用，一篇文章仅引用对应文件夹中的图片。

eq: `/quick-start.md` -> `/images/quick-start/xxx`

### md 语法

文章统一以一级标题开头，大纲显示二至四级标题。

使用 `> ` 作为普通引用标志，`:::warning` 等块级 container 仅用于语义化表达，不得滥用。

使用 `- ` 作为无序列表标志，`1. ` 作为有序列表标志。

使用 `\`code\`` 书写行内代码，`\`\`\`{language}` 书写代码块。

分段均使用换行分割，硬换行均使用 `  ` + 换行符。

中英文间使用空格进行分割。