EnderRealm 技术文档

外观

Markdown 语法基础 ​

Markdown 是一种轻量级标记语言，EnderRealm 项目使用 Markdown 编写文档。

什么是 Markdown？ ​

Markdown 由 John Gruber 在 2004 年创建，是一种易于阅读和编写的标记语言。它的特点包括：

  • 简洁：语法简单，易于学习
  • 易读：源码和渲染结果都很清晰
  • 通用：被广泛支持（GitHub、GitLab、Reddit 等）
  • 灵活：可以转换为 HTML、PDF 等格式

为什么学习 Markdown？ ​

在 EnderRealm 项目中，Markdown 用于：

  • 编写文档：项目文档、API 文档
  • 编写 README：项目介绍和使用说明
  • 编写 Issue：GitHub 问题描述
  • 编写 PR：Pull Request 描述
  • 编写注释：代码中的文档注释

基础语法 ​

标题 ​

使用 # 号创建标题，一个 # 是一级标题，两个 ## 是二级标题，以此类推。

markdown
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

渲染结果：

一级标题 ​

二级标题 ​

三级标题 ​

四级标题 ​

五级标题 ​
六级标题 ​

段落 ​

段落之间使用空行分隔：

markdown
这是第一段。

这是第二段。

渲染结果：

这是第一段。

这是第二段。

强调 ​

使用 * 或 _ 创建斜体，使用 ** 或 __ 创建粗体：

markdown
*斜体* 或 _斜体_

**粗体** 或 __粗体__

***粗斜体*** 或 ___粗斜体___

渲染结果：

斜体 或 斜体

粗体 或 粗体

粗斜体 或 粗斜体

列表 ​

无序列表 ​

使用 -、* 或 + 创建无序列表：

markdown
- 项目 1
- 项目 2
  - 子项目 2.1
  - 子项目 2.2
- 项目 3

渲染结果：

  • 项目 1
  • 项目 2
    • 子项目 2.1
    • 子项目 2.2
  • 项目 3

有序列表 ​

使用数字加 . 创建有序列表：

markdown
1. 第一步
2. 第二步
3. 第三步

渲染结果：

  1. 第一步
  2. 第二步
  3. 第三步

链接 ​

使用 [文本](URL) 创建链接：

markdown
[GitHub](https://github.com)

[EnderRealm 项目](https://github.com/EnderRealmMC/EnderRealmServerCore)

渲染结果：

GitHub

EnderRealm 项目

图片 ​

使用 ![替代文本](图片URL) 插入图片：

markdown
![EnderRealm Logo](https://example.com/logo.png)

渲染结果：

EnderRealm Logo

代码 ​

行内代码 ​

使用反引号 `` ` 创建行内代码：

markdown
使用 `git clone` 命令克隆仓库。

渲染结果：

使用 git clone 命令克隆仓库。

代码块 ​

使用三个反引号 ``` 创建代码块，可以指定语言：

markdown
```java
public class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}
```

渲染结果：

java
public class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}

常用语言标识：

  • java - Java
  • python - Python
  • bash - Bash/Shell
  • sql - SQL
  • json - JSON
  • yaml - YAML
  • xml - XML
  • html - HTML
  • css - CSS
  • javascript - JavaScript

引用 ​

使用 > 创建引用：

markdown
> 这是一段引用。
>
> 这是引用的第二段。

渲染结果：

这是一段引用。

这是引用的第二段。

分割线 ​

使用三个或更多的 -、* 或 _ 创建分割线：

markdown
---
***
___

渲染结果：

表格 ​

使用 | 创建表格：

markdown
| 列1 | 列2 | 列3 |
|-----|-----|-----|
| 单元格1 | 单元格2 | 单元格3 |
| 单元格4 | 单元格5 | 单元格6 |

渲染结果：

列1列2列3
单元格1单元格2单元格3
单元格4单元格5单元格6

可以设置对齐方式：

markdown
| 左对齐 | 居中对齐 | 右对齐 |
|:------|:-------:|-------:|
| 左 | 中 | 右 |

渲染结果：

左对齐居中对齐右对齐
左中右

任务列表 ​

使用 - [ ] 和 - [x] 创建任务列表：

markdown
- [ ] 未完成任务
- [x] 已完成任务
- [ ] 另一个未完成任务

渲染结果：

  • [ ] 未完成任务
  • [x] 已完成任务
  • [ ] 另一个未完成任务

转义字符 ​

使用 \ 转义特殊字符：

markdown
\*这不是斜体\*

\[这不是链接\]

渲染结果：

*这不是斜体*

[这不是链接]

VitePress 扩展语法 ​

EnderRealm 文档使用 VitePress 构建，支持一些扩展语法：

提示框 ​

markdown
::: tip 提示
这是一个提示框。
:::

::: warning 警告
这是一个警告框。
:::

::: danger 危险
这是一个危险框。
:::

::: details 详细信息
这是一个可折叠的详细信息框。
:::

渲染结果：

提示

这是一个提示框。

警告

这是一个警告框。

危险

这是一个危险框。

详细信息

这是一个可折叠的详细信息框。

代码组 ​

markdown
::: code-group

```java [Java]
System.out.println("Hello");
```

```python [Python]
print("Hello")
```

```bash [Bash]
echo "Hello"
```

:::

渲染结果：

java
System.out.println("Hello");
python
print("Hello")
bash
echo "Hello"

编写文档的建议 ​

1. 使用清晰的标题 ​

标题应该简洁明了，能够概括内容：

markdown
# 好的标题
## 安装 JDK 21

# 不好的标题
## 第一部分
## 步骤 1

2. 使用列表组织内容 ​

列表使内容更易读：

markdown
## 安装步骤

1. 下载安装包
2. 运行安装程序
3. 配置环境变量
4. 验证安装

3. 使用代码块展示命令 ​

命令和代码应该放在代码块中：

markdown
运行以下命令安装依赖：

​```bash
npm install
​```

4. 使用表格展示对比信息 ​

表格适合展示对比信息：

markdown
| 版本 | 用途 | 必需性 |
|------|------|--------|
| JDK 21 | 主要开发 | ✅ 必需 |
| JDK 17 | 构建 Floodgate | ✅ 必需 |

5. 使用提示框强调重要信息 ​

提示框可以吸引读者注意：

markdown
::: warning 警告
此操作不可逆，请谨慎操作！
:::

推荐学习资源 ​

下一步 ​

Markdown 语法学习完成后，让我们进入阶段二：获取代码。

© 2022-present EnderRealm. All rights reserved.