---
url: /README.md
---
# EnderRealm-DOCS

欢迎来到 **EnderRealm 公共文档仓库**。

本项目基于 **VitePress** 构建，采用现代化的静态站点生成方案，支持 Markdown 文档的实时预览与构建。这种设计极大地方便了协作贡献——你只需要关注内容本身，无需处理复杂的构建流程。

作为 EnderRealm 的公共文档仓库，**任何人都可以在这里提交内容**。只要符合服务器相关规定，哪怕只是修改一个错别字，你也会被视为合格的贡献者。服务器的各类攻略、说明文档等，你都有权限编辑。通过贡献你的时间与知识，你将真正成为项目的一份子。

***

## 🚀 如何贡献

### 前置条件

* **Node.js**（推荐 18.0 或更高版本）
* **Git**

### 流程：本地 Git + 本地预览

1. **Fork 并克隆仓库**\
   先将本仓库 Fork 到你的 GitHub 账户，然后将仓库克隆到本地计算机。

2. **安装依赖**\
   在项目根目录运行：
   ```bash
   npm install
   ```

3. **启动本地预览**
   ```bash
   npm run docs:dev
   ```
   启动后，用浏览器访问 `http://localhost:5173` 即可看到与文档中心一致的页面。

4. **编写或编辑文档**
   * 所有文档**必须位于项目根目录下**，按中文命名的文件夹进行分类（如 `官方文档/`、`指南/` 等）。
   * 文件名可以使用中文、英文或连字符（-），例如 `EnderRealm基本章程.md`。
   * 使用你喜欢的编辑器修改 Markdown 文件，**请时刻保存后刷新本地预览页面**，确认渲染效果无误。

5. **提交并推送**\
   将你的修改提交到本地仓库，并推送到你 Fork 的远程仓库。

6. **发起 Pull Request**\
   在 GitHub 上你的 Fork 仓库页面，点击 **“Contribute” → “Open pull request”**，填写说明后提交。

7. **等待审核**

> ⚠️ **特别提醒**：
>
> * 不要跳过本地预览步骤。即使你在其他编辑器里看着正常，也可能因为语法差异而导致最终网站显示异常。
> * 如果你只是修改一处错别字或简单格式，可以不启动预览服务器，但建议仍用本地预览检查一下。

***

## ⚠️ 重要注意事项

> **通用原则**：本文档中的规范为通用标准。若特定文档或类别有特殊规则，则以特殊规则为准。

### 文档存放位置

* 所有文档**必须位于项目根目录下的中文命名文件夹中**（如 `官方文档/`、`指南/` 等），**不允许放置在其他任何位置**。
* **官方内容统一收录在 `官方文档/` 下**，按性质分入二级分类文件夹：约束性文书（章程、守则、协议等）放 `官方文档/协议与政策/`，对外公示的名单放 `官方文档/公示名单/`。
* **你可以自由创建子文件夹**来分类管理文档。
* **勿擅自修改** `.vitepress/` 目录下的配置文件或其他非文档类文件。

### 命名规范

* 文件夹和文件名可以使用**中文、英文或连字符（-）**，例如 `官方文档/协议与政策/EnderRealm基本章程.md`。
* **禁止使用拼音**（如 `xieyi-yu-zhengce`）和空格，以确保内容清晰易懂。

### 内容规范

* 正文内容应使用**简体中文**撰写，确保清晰易懂。
* **禁止在正文中使用拼音**（如 `xieyi`），拼音仅允许作为生僻字的注音批注（例如：「茕茕孑立（qióng qióng jié lì）」）。
* 除非是**英文专有名词**（如 `Minecraft`、`VitePress`）或其他语言的专有名词，否则正文中不得出现非中文内容。

### 目录索引（index.md）

每个文件夹**必须包含一个 `index.md` 文件**作为该目录的索引页。索引页应列出该目录下的所有文档链接，方便用户浏览。

示例：

```markdown
# 协议与政策

本页面收录了 EnderRealm 的各项协议与政策文档。

## 文档列表

- [EnderRealm 基本章程](/官方文档/协议与政策/EnderRealm基本章程)
- [EnderRealm 玩家守则](/官方文档/协议与政策/EnderRealm玩家守则)
- [EnderRealm 隐私政策](/官方文档/协议与政策/EnderRealm隐私政策)
```

添加新文档时，请同步更新对应目录的 `index.md`。

***

## 📄 许可协议

除非特殊情况，本项目中的文档采用以下双重许可方式：

### 1. 官方性质文档（如服务器规则、管理公告等）

这类文档采用 **CC BY-NC-ND 4.0 协议**（署名 - 非商业性使用 - 禁止演绎 4.0 国际）。

* **您可以自由分享** —— 以任何媒介或形式复制、分发本作品，但**必须给出适当的署名**，并提供许可协议链接
* **非商业性使用** —— 您**不得将本作品用于商业目的**
* **禁止演绎** —— 如果您对本作品进行混合、转换或基于本作品进行创作，您**不得分发修改后的作品**

### 2. 玩家自主编写的内容（如攻略、说明、故事、心得等）

除非另有特殊声明，**所有由社区玩家贡献的非官方文档**均采用 **CC BY-NC-SA 4.0 协议**（署名 - 非商业性使用 - 相同方式共享 4.0 国际）。该协议要求署名、非商业性使用，并以相同方式共享。

* **您可以自由地**：共享（以任何媒介或形式复制、分发本作品）、演绎（修改、转换、基于本作品进行创作）
* **主要条款**：必须给出适当的署名；不得将本作品用于商业目的；如果您对本作品进行修改或基于本作品创作，必须以相同的许可协议分发您的贡献

> 简单理解：你可以搬运、改编玩家写的攻略，但必须注明原作者，不得用于商业用途，并且改编后的内容也要用同样的协议开放出来。

**提交贡献即表示您同意您所编写的内容（根据其性质）遵循上述对应协议。**

特殊情况由项目维护者另行声明。

***

## 💬 结语

感谢你愿意为 **EnderRealm 社区**贡献一份力量。

无论是修正一个错别字，还是撰写完整的攻略文档，每一份贡献都会让这个服务器变得更好。

> 如有任何疑问，欢迎在 Pull Request 中留言或通过社区渠道联系维护者。

**期待你的参与！** 🎉