Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs Translation (zh-CN) #74

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Docs Translation (zh-CN) #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
53748f4
Docs Translation (zh-CN)
OakPlatinum Dec 28, 2024
2279c1c
Example Mod Translation (zh-CN)
OakPlatinum Dec 28, 2024
d17360c
README Translation (zh-CN)
OakPlatinum Dec 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions README/README_ZH_CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Sinytra Minecraft 模组维基

欢迎来到 Minecraft 模组维基，这是一个供所有人托管和分享他们的模组文档的公共平台。

Minecraft 模组维基旨在满足 Minecraft 模组制作者和玩家的需求。它提供了直观的导航，清晰的用户界面，模组浏览器以及供作者轻松编写文档的功能。

这些功能包括版本控制，本地化，自定义组件（配方，资源等）， gradle 集成，项目管理等等。

- 🌐 **本地化**：将您的文档翻译成世界语言
- 🚹 **可访问性**：直观且响应式的用户界面
- 🤝 **开放**：让您的用户无需任何编程知识即可参与贡献
- 💸 **免费**：在我们的网站上托管文档完全免费！

## 作者

本仓库的 `example` 目录中包含一个示例文档设置。

## 开发

1. 将 `.env.local.example` 重命名为 `.env.local`
2. 创建一个新的 [GitHub 应用程序](https://github.com/settings/apps/new)。填写以下信息：
- `APP_AUTH_GITHUB_ID` - 应用程序 ID
- `APP_AUTH_GITHUB_PRIVATE_KEY` - 生成的 [私钥](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps)
- `AUTH_GITHUB_ID` - 客户端 ID
- `AUTH_GITHUB_SECRET` - 客户端密钥
3. 运行 `npm run dev` 启动应用程序

您可以在 `LOCAL_DOCS_ROOTS` 环境变量中列出所需的本地文档源，如示例所示。

## 致谢

_（请参阅英文 README 的 Credits 部分）_
36 changes: 15 additions & 21 deletions docs/about/zh_cn.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,26 @@
# About
# 关于

Welcome to the Modded Minecraft Wiki, a common place for everyone to host and share documentation of their mods.
欢迎来到 Minecraft 模组维基，这是一个供所有人托管和分享他们的模组文档的公共平台。

The Modded Minecraft Wiki is built to suit the very needs of Minecraft modders and players alike. It provides
intuitive navigation, a clean user interface, mod browser and features for authors to make writing documentation
a piece of cake.
Minecraft 模组维基旨在满足 Minecraft 模组制作者和玩家的需求。它提供了直观的导航，清晰的用户界面，模组浏览器以及供作者轻松编写文档的功能。

These include versioning, localization, custom components (recipes, assets, etc.), gradle integration,
project management and more.
这些功能包括版本控制，本地化，自定义组件（配方，资源等）， gradle 集成，项目管理等等。

- 🌐 **Localization**: Translate your docs into world languages
- 🚹 **Accessible**: Intuitive and responsive user interface
- 🤝 **Open**: Let your users contribute without any programming knowledge necessary
- 💸 **Free**: Hosting docs on our website is completely free of charge!
- 🌐 **本地化**：将您的文档翻译成世界语言
- 🚹 **可访问性**：直观且响应式的用户界面
- 🤝 **开放**：让您的用户无需任何编程知识即可参与贡献
- 💸 **免费**：在我们的网站上托管文档完全免费！

## Who we are
## 我们是谁

The Wiki is built and mainained by [Sinytra](https://github.com/Sinytra), a team of passionate developers creating
Free and Open Source common Minecraft modding software.
这个 Wiki 是由 [Sinytra](https://github.com/Sinytra) 构建和维护的， Sinytra 是一个充满激情的开发者团队，致力于创建免费和开源的Minecraft模组通用软件。

If you like our work, feel free to check out our [other projects](https://github.com/Sinytra) found on our GitHub page ❤️.
如果您喜欢我们的工作，请随时查看我们在 GitHub 页面上的[其他项目](https://github.com/Sinytra) ❤️。

## Contributing
## 贡献

### Mod documentation
### 模组文档

To edit a mod documentation page, use the `Edit page on GitHub` button found at the bottom of the right side panel.
要编辑一个模组文档页面，请使用右侧边栏底部找到的`在 GitHub 上编辑页面`按钮。

As mod documentation is sourced from GitHub repositories, you can either use the GitHub web editor, or clone the
repository and make changes locally. Then, once you're done making changes, you can submit a Pull Request to the
upstream repository and wait for it to be reviewed / merged by a maintainer.
由于模组文档来源于 GitHub 仓库，您可以使用 GitHub 网络编辑器，或者克隆仓库并在本地进行更改。然后，一旦您完成更改，您可以向上游仓库提交一个 Pull Request ，并等待维护者进行审查/合并。
55 changes: 24 additions & 31 deletions docs/community/zh_cn.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,54 +1,47 @@
# Community Mod Documentation
# 社区模组文档

**🌐 The central repository for community documentation can be found [here](https://github.com/Sinytra/CommunityWikiDocs).**
**🌐 社区文档的中心仓库可以在[这里](https://github.com/Sinytra/CommunityWikiDocs)找到。**

The README of the repo is displayed below:
以下是该仓库的 README 内容：

---

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/Sinytra/CommunityWikiDocs?quickstart=1)
[![在 GitHub Codespaces 中打开](https://github.com/codespaces/badge.svg)](https://codespaces.new/Sinytra/CommunityWikiDocs?quickstart=1)

A collection of community documentation for the [Modded Minecraft Wiki](https://moddedmc.org/).
为[Minecraft模组维基](https://moddedmc.org/)收集的社区文档。

📖 This repository serves as a source of unofficial documentation for minecraft mods contributed by the community
and maintained by the Modded Minecraft Wiki developer team / Sinytra.
📖 这个仓库作为由社区贡献并由Minecraft模组维基开发者团队/Sinytra维护的非官方模组文档的来源。

📂 Each subdirectory (with the exception of `gradle`) contains a Wiki project with documentation files and metadata.
Registration of projects to the Wiki is handled automatically.
📂 每个子目录（`gradle`除外）都包含一个Wiki项目，其中包含文档文件和元数据。项目的Wiki注册是自动处理的。

## 🤝 Contributing
## 🤝 贡献

We welcome all contributions - no coding knowledge is required!
我们欢迎所有贡献 - 无需编码知识！

1. Start by opening the repository in your favourite editor or IDE.\
You can also use [GitHub Codespaces](https://codespaces.new/Sinytra/CommunityWikiDocs?quickstart=1) in the browser
for a quick setup (supports live previews, too!).
1. 首先在您喜欢的编辑器或 IDE 中打开仓库。\
您还可以在浏览器中使用[GitHub Codespaces](https://codespaces.new/Sinytra/CommunityWikiDocs?quickstart=1)进行快速设置（也支持实时预览！）。

2. Launch a local preview by running `./gradlew previewDocs` in the terminal and wait until the environment has finished
setting up.
2. 在终端中运行 `./gradlew previewDocs` 启动本地预览，并等待环境设置完成。

3. Once the preview instance is ready, the editor will prompt you to open it in a new tab. Click `Open in Browser`.\
Alternatively, you can find a link in the `PORTS` tab next to the terminal.
3. 一旦预览实例准备好，编辑器将提示您在新标签页中打开它。点击`在浏览器中打开`。\
或者，您可以在终端旁边的`PORTS`标签中找到一个链接。

4. You're ready to start editing docs! 🎉
4. 您现在可以开始编辑文档了！ 🎉

To learn more about the documentation file format used, see [this page](https://moddedmc.org/en/about/format).
要了解有关使用的文档文件格式的更多信息，请参阅[这个页面](https://moddedmc.org/en/about/format)。

### Existing projects
### 现有项目

Making changes to existing projects is fairly simple. Find the project you'd like to update and make desired changes
to documentation files. Once you're done, commit your working tree and [create a Pull Request](https://github.com/Sinytra/CommunityWikiDocs/compare)
with your changes.
对现有项目进行更改相当简单。找到您想要更新的项目，并按照需要对文档文件进行更改。完成后，提交您的工作树并使用您的更改[创建一个Pull Request](https://github.com/Sinytra/CommunityWikiDocs/compare)。

### New projects
### 新项目

Adding new projects can be done in two easy steps:
添加新项目可以通过两个简单步骤完成：

1. Create a subdirectory for the mod you're going to document. The name of this directory should match the value of the
`id` field in the project [metadata file](https://moddedmc.org/en/about/devs#wiki-metadata).
1. 为您将要记录的模组创建一个子目录。这个目录的名称应该与项目[元数据文件](https://moddedmc.org/en/about/devs#wiki-metadata)中的`id`字段的值相匹配。

2. Add the name of the subdirectory to the `documentation_roots` property inside `gradle.properties`.
2. 将子目录的名称添加到`gradle.properties`文件中的`documentation_roots`属性。

## ✍️ Become an editor
## ✍️ 成为编辑

(Registration coming soon, stay tuned!)
（注册开放即将到来，敬请期待！）
Loading