这是 Easy4Form 项目的文档仓库。Easy4Form 是一个简化的表单 API，专为 Floodgate 设计，让 Java 服务器更容易创建和发送表单给基岩版玩家。

Easy4Form 提供了一套简洁易用的 API，帮助 Minecraft 服务器开发者：

• 🎯 简化表单创建 - 提供直观的 API 来创建各种类型的表单
• 🔧 易于集成 - 与现有的 Floodgate 插件无缝集成
• 📱 基岩版支持 - 专门为 Minecraft 基岩版玩家设计
• 🌐 多语言文档 - 提供中英文双语文档支持

• 主项目仓库: https://cnb.cool/EnderRealm/public/Easy4Form
• 文档项目: https://cnb.cool/EnderRealm/public/DOCS/Easy4FormDocs

我们欢迎社区贡献！以下是参与贡献的方式：

1. Fork 本仓库
2. 创建新分支 - git checkout -b feature/improve-docs
3. 编辑文档 - 按照下面的文档规范进行修改
4. 提交更改 - git commit -m "docs: 改进API文档说明"
5. 推送分支 - git push origin feature/improve-docs
6. 创建 Pull Request

• 发现文档错误或不清楚的地方？请创建 Issue
• 建议改进文档结构或内容？欢迎讨论
• 需要新的示例代码？告诉我们你的需求

• 帮助改进现有的中英文翻译
• 添加其他语言的文档支持
• 确保技术术语的一致性

.
├── .vitepress/          # VitePress 配置
│   ├── config.mts        # 主配置文件
│   └── theme/            # 主题自定义
├── api/                  # 英文 API 文档
├── zh/                   # 中文文档
│   ├── api/              # 中文 API 文档
│   ├── v1/               # v1 版本文档
│   └── v2/               # v2 版本文档
├── v1/                   # 英文 v1 版本文档
├── v2/                   # 英文 v2 版本文档
└── README.md             # 本文件

• 使用 ```java 标记 Java 代码块
• 提供完整的导入语句
• 包含必要的注释说明
• 确保代码可以直接运行

• 使用 Markdown 格式
• 标题层级清晰（# ## ### ####）
• 适当使用表格、列表和引用
• 添加必要的链接和交叉引用

• 英文文档放在根目录或对应版本目录
• 中文文档放在 zh/ 目录下
• 保持两种语言的文档结构一致
• 及时同步更新内容

• v1/ - 旧版本文档（维护模式）
• v2/ - 最新版本文档（主要更新）
• api/ - 通用 API 参考文档

• 使用 TypeScript 配置文件 (.mts)
• 支持国际化 (i18n)
• 配置正确的导航和侧边栏
• 已配置禁用 HTML 标签解析以避免 Java 类名解析冲突

使用语义化提交信息：

• docs: 添加新的API示例 - 文档更新
• fix: 修复代码示例错误 - 错误修复
• feat: 添加新的文档章节 - 新功能
• style: 改进文档格式 - 格式调整
• refactor: 重构文档结构 - 结构重构

# 安装依赖
npm install

# 启动开发服务器
npm run docs:dev

# 构建文档
npm run docs:build

# 预览构建结果
npm run docs:preview

• Node.js 18+
• npm 或 yarn
• VitePress 2.x

本文档项目遵循与主项目相同的许可证。详情请查看主项目仓库。

• 项目讨论：在主项目仓库创建 Issue
• 文档问题：在本仓库创建 Issue

---

感谢您对 Easy4Form 项目的关注和贡献！🎉