成为 Wiki 编者

考虑到大多数编者都是非专业的，我们需要提供一些简单的步骤来帮助他们成为 Wiki 编者。

步骤 1：注册gitee账号

1. 访问 gitee 网站。
2. 点击注册按钮，填写必要的信息，包括用户名、密码等。
3. 完成注册后，登录到 gitee 账号。
4. 绑定邮箱，确保后续操作时能够收到通知。

注册gitee账号

绑定邮箱通知

步骤 2：下载编辑器

1. 推荐编辑器：tare、webstorm、vscode
2. 下载并安装编辑器，如需登录，请先登录。

提示

此处编者在使用 tare 编辑器，以下操作基于 tare 编辑器进行，其他编辑器操作类似，只是界面不同，操作步骤相同。

步骤 3：克隆项目

1. 新建一个项目文件夹，例如 scwk-docs，位置和名字随意。
2. 复制以下链接：

https://gitee.com/SC-SPM/scwk-docs.git

3. 打开编辑器，选择“从 Git 仓库克隆”。
4. 粘贴链接，选择刚才新建的项目文件夹，点击“选择为存储目标”按钮。

1.新建项目文件夹

2.选择“从 Git 仓库克隆”按钮

3.粘贴链接

4.选择项目文件夹，点击“选择为存储目标”按钮

步骤 4：认识操作与提交代码

1. 你将看到编辑器的主界面，包括左侧的文件树、右侧的代码编辑区域、底部的工具栏等。

2. 创建或编辑文件：

   • 在左侧文件树中找到要编辑的文件，点击打开。
   • 如需创建新文件，右键点击文件夹，选择"新建文件"，输入文件名（如 new-page.md）。
   • 在右侧编辑区域编写内容，支持 Markdown 语法。

3. 启用预览

   1. 点击工具栏顶部的“面板”按钮，打开终端。

   如果是第一次使用，需要安装依赖，执行以下命令：

   npm install

   2. 安装完成后，输入以下命令启用预览：

   npm run docs:dev

   3. 启用完成后会显示以下内容：

     vitepress v1.6.4
   
   ➜  Local:   http://localhost:xxxx/
   ➜  Network: use --host to expose
   ➜  press h to show help

   4. 点击左侧工具栏的“预览”按钮，在顶部网址输入栏输入 http://localhost:xxxx/ 即可查看预览效果。

4. 预览效果：

   • 大多数编辑器支持实时预览功能，点击预览按钮即可查看渲染效果。
   • 确保格式正确，包括标题、列表、链接等。

5. 保存更改：

   • 使用快捷键 Ctrl+S（Windows）或 Cmd+S（Mac）保存文件。
   • 编辑器底部会显示文件状态变化。
   • 需要保存文件后，预览效果才会更新。

6. 提交代码（终端提交）：

   • 打开终端（编辑器内置或系统终端），进入项目目录。
   • 查看更改：git status
   • 添加更改：git add .（添加所有更改）或 git add 文件名（添加特定文件）
   • 提交更改：git commit -m "描述你的更改内容"
   • 推送到远程仓库：git push origin main

7. 提交代码（图形提交）：

   • 点击左侧工具栏的“源代码管理”按钮。
   • 填写提交信息，点击“提交”按钮。
   • 再次点击“同步更改”后，会自动推送更改到远程仓库。

   需要登陆gitee账号

   若未登录，会提示登录，输入绑定的邮箱和gitee密码即可登录。

   • 提交后10分钟内，会自动更新到 Wiki 页面。

tare的操作界面

如何提交文件与代码

附录 项目结构

了解项目结构有助于你更快地找到需要修改的文件。本项目采用 VitePress 构建，整体结构清晰明了。

注意

以下附录不会因为项目的更新而改变，仅用于参考。

scwk-docs/                           # 项目根目录
├── docs/                            # 文档主目录，所有文档内容都在这里
│   ├── .vitepress/                  # VitePress 配置目录
│   │   ├── theme/                   # 自定义主题和组件
│   │   │   ├── generated/           # 自动生成的 JSON 数据文件
│   │   │   ├── *.vue                # Vue 组件（如物品搜索、贡献者展示等）
│   │   │   ├── index.ts             # 主题入口文件
│   │   │   └── style.css            # 全局样式文件
│   │   └── config.mts               # VitePress 主配置文件（侧边栏、导航栏等）
│   ├── database/                    # 方块与物品数据库
│   │   ├── index.md                 # 数据库首页
│   │   ├── items.md                 # 物品列表
│   │   ├── recipes.md               # 合成配方
│   │   ├── clothes.md               # 衣物装备
│   │   ├── clothing.md              # 衣物与盔甲数值
│   │   ├── tools.md                 # 工具
│   │   ├── weapons.md               # 武器
│   │   ├── food.md                  # 食物
│   │   ├── minerals.md              # 矿物
│   │   ├── plants.md                # 植物
│   │   ├── terrain.md               # 地形方块
│   │   ├── construction.md          # 建筑材料
│   │   ├── electrics.md             # 电路元件
│   │   ├── fireworks.md             # 烟花
│   │   └── spawner-eggs.md          # 刷怪蛋
│   ├── community/                   # 社区相关文档
│   │   ├── contribute.md            # 贡献指南
│   │   ├── history.md               # 项目历史
│   │   └── how-tobe-editor.md       # 成为编者教程（本文档）
│   ├── developer/                  # 开发者手册
│   │   ├── modding/                 # MOD 制作教程
│   │   │   ├── index.md             # MOD 开发首页
│   │   │   ├── project-setup.md     # 项目搭建
│   │   │   ├── architecture-tooling.md # 架构与工具
│   │   │   ├── data-assets.md       # 数据资产
│   │   │   ├── assets-models.md     # 资源与模型
│   │   │   ├── suapi.md             # SUAPI 接口
│   │   │   ├── dll-plugins.md       # DLL 插件
│   │   │   ├── legacy-data-files.md # 遗留数据文件
│   │   │   ├── examples.md          # 示例代码
│   │   │   └── release.md           # 发布流程
│   │   ├── server/                  # 服务器搭建（开服、配置、部署与运维）
│   │   │   ├── index.md             # 多人游戏概览
│   │   │   ├── requirements.md      # 版本与运行环境
│   │   │   ├── quick-start.md       # 快速开服
│   │   │   ├── configuration.md     # 配置与 SCKey
│   │   │   ├── pocket-survival.md   # 口袋生存服
│   │   │   ├── operations.md        # 运维管理
│   │   │   └── public-deployment.md # 公服部署
│   │   ├── server-plugins/          # 服务器插件开发
│   │   │   ├── index.md             # 服务器插件首页
│   │   │   ├── first-plugin.md      # 第一个插件
│   │   │   ├── events-commands.md   # 事件与命令
│   │   │   └── examples.md          # 示例代码
│   │   └── server-plugin-api.md     # 服务器插件 API 文档
│   ├── guide/                       # 新手教程
│   │   ├── getting-started.md       # 快速上手
│   │   ├── first-day.md             # 第一天生存
│   │   ├── crafting.md              # 合成系统
│   │   ├── building.md              # 建筑指南
│   │   ├── combat-traps.md          # 战斗与陷阱
│   │   ├── game-modes.md            # 游戏模式
│   │   ├── controls.md              # 操作控制
│   │   ├── production-facilities.md # 生存与生产设施
│   │   ├── animals.md               # 动物
│   │   ├── characters.md            # 角色
│   │   ├── items.md                 # 物品详解
│   │   ├── advanced.md              # 高级技巧
│   │   ├── survival-planning.md     # 生存规划
│   │   ├── glossary.md              # 术语表
│   │   └── local-multiplayer.md     # 原版同屏多人（联机入门）
│   ├── theory/                      # 理论与机制
│   │   ├── mining.md                # 挖矿指南
│   │   ├── tools-weapons.md         # 工具与武器
│   │   ├── experience-levels.md     # 经验与等级
│   │   ├── food.md                  # 食物与腐败
│   │   ├── farming.md               # 农业机制
│   │   ├── biomes.md                # 生物群系
│   │   ├── weather-seasons.md       # 天气与季节
│   │   ├── sleep-mechanics.md       # 睡眠机制
│   │   ├── fire-explosives.md       # 火与爆炸物
│   │   ├── furniture.md             # 家具
│   │   ├── practical-mechanics.md   # 实用机械
│   │   ├── travel.md                # 旅行探索
│   │   ├── navigation-compass.md    # 导航与指南针
│   │   ├── circuits.md              # 电路基础
│   │   ├── circuit-logic.md         # 电路逻辑
│   │   └── world-saves.md           # 世界数据、备份与修复
│   ├── modwiki/                     # 模组百科（建设中）
│   │   └── index.md                 # 模组百科首页
│   ├── resources/                   # 资源导航
│   │   ├── index.md                 # 资源导航首页
│   │   ├── version-landscape.md     # 国内版本生态
│   │   ├── downloads.md             # 版本与下载说明
│   │   ├── content-and-assets.md    # 内容与素材说明
│   │   ├── source-coverage.md       # 源代码覆盖说明
│   │   ├── thanks.md                # 致谢
│   │   ├── yuque-migration.md       # 语雀迁移说明
│   │   └── english-wiki-migration.md # 英文 Wiki 迁移说明
│   ├── public/                      # 静态资源目录（图片、图标等）
│   │   ├── illustrations/           # 文章配图（按大板块分 guide/theory/resources 等子目录）
│   │   ├── archive-images/          # 归档图片（从旧 Wiki 迁移）
│   │   ├── contributors/            # 贡献者头像
│   │   └── game-assets/             # 游戏素材（方块、角色、装备等）
│   └── index.md                     # 网站首页
├── scripts/                         # 辅助脚本目录
│   ├── generate-game-catalog.mjs    # 生成物品目录数据
│   ├── generate-contributors.mjs    # 生成贡献者列表
│   ├── sync-contributor-avatars.mjs # 同步贡献者头像
│   ├── crop-block-textures.ps1      # 裁剪方块纹理
│   ├── render-game-models.py        # 渲染游戏模型
│   └── requirements-assets.txt      # Python 依赖
├── .gitignore                       # Git 忽略文件配置
├── .mailmap                         # 邮箱映射文件
├── AGENTS.md                        # AI 代理配置说明
├── LICENSE                          # 许可证文件
├── package.json                     # 项目依赖配置（npm install 所需）
└── README.md                        # 项目说明文档

目录用途详解

目录	用途	适用场景
database/	方块与物品数据库，包含所有可收集、合成、使用的物品信息	添加新物品、修改物品属性
guide/	新手教程与联机入门，帮助玩家快速上手	编写新手教程、同屏多人文章
theory/	理论与机制，采矿、农业、电路、世界数据等深度机制与进阶攻略	编写机制详解、攻略文章
modwiki/	模组百科（建设中），收录社区 MOD 条目	添加 MOD 条目与兼容说明
developer/	开发者文档，涵盖 MOD 制作、服务器搭建和服务器插件开发	编写开发教程、API 文档
developer/server/	服务器搭建，包含服务器配置、部署、运维等	添加服务器教程、配置说明
res-community/	资源与社区合并目录：资源导航、版本说明、下载链接、致谢、贡献指南、项目历史等	更新资源链接、版本信息与社区内容
（社区文档已并入上方 res-community/）	同上	更新贡献流程、添加新编者
public/	静态资源存储，所有图片、素材都放在这里	添加截图、游戏素材
.vitepress/theme/	主题组件，控制网站外观和交互功能	修改页面样式、添加新组件
scripts/	自动化脚本，用于生成数据、同步资源等	运行数据生成、资源同步

快速定位文件

• 想添加游戏物品信息 → database/ 下对应的文件
• 想编写新手教程 → guide/ 下创建或修改文档
• 想编写机制理论或进阶攻略 → theory/ 下创建或修改文档
• 想添加开发教程 → developer/ 下对应的子目录
• 想添加服务器教程 → developer/server/ 下创建或修改文档
• 想添加资源链接 → res-community/ 下创建或修改文档
• 想修改网站导航 → .vitepress/config.mts
• 想添加文章配图 → public/illustrations/ 下按所属大板块选择子目录