Skip to content

Latest commit

 

History

History
156 lines (98 loc) · 10.1 KB

CONTRIBUTING.zh-CN.md

File metadata and controls

156 lines (98 loc) · 10.1 KB
Raw

贡献指南

欢迎来到文档中心，这篇说明文档旨在促进贡献者 (你) 对我们知识库的易理解性和降低对仓库进行贡献的难度。我们的文档证明了我们对清晰和高效的承诺，精心构建以确保其易读性和连贯性。

仓库结构

我们存储库的主要目录位于 data 文件夹中的两个目录：docs 和 blogs。blogs 目录是我们工作室公告和一个有见地的博客写手的圣地————不受外部贡献影响的空间。

我们暂时没有对外界开放编辑 blog 部分的想法。因此现在您暂时只能在 blog 中看到来自 iNKORE! 的内容。

以下是文档目录层次结构和文档的命名方式。

分类文件夹

这些是我们的内容分组的广泛分类，其一般用两位数字后跟句号和空格命名，然后附加类别名称，格式为烤肉串 (kebab 格式) 大小写。例如，名为 01. ui-elements 表示侧边栏中的第一个类别，与用户界面元素有关。

  • 分类元数据文件：在每个类别文件夹中，元数据文件是我们结构的基本信息概述，提供对内容进行分类的基本细节。特定于语言的元数据 (如显示名称和说明) 驻留在语言编码文件 (如_category_.en-US.json) 中。

    关于 _category_.json 的更多信息，请参见: autogenerated#category-item-metadata

文章文件夹

每篇文章都有其指定的文件夹，由一个两位数的数字表示 + "." (如果你想手动排序)，一个 # 号加空格，再加上 kebab 格式的 slug 以及烤肉串盒中的蛞蝓组成。举个例子，一篇关于按钮设计的文章会嵌套在文件夹中，如下所示：02.# button-design。在列举控件和 API 的时候，我们更倾向于让其根据字母自动排序，就可以写：# button-design。

示例：index.en-US.mdx，index.zh-CN.mdx

  • 图像命名：文章中的图片应当和 index.{语言代号}.mdx 存在同一目录内，并且以简短的 kebab 形式命名，比如 create-a-new-project.png。对于屏幕截图和其他较小的图片，请使用 PNG 格式，对于较大的图片，请使用 JPG 或 JPEG 格式。

    示例：create-new-project.png，mountain-view.jpg

贡献细节

对于贡献者来说，了解我们的结构复杂性至关重要。

使用 MDX 和 Markdown 编写

MDX 的强大功能可以将内容与其独特功能相结合。使用 Markdown 清晰地重建您的想法，并使用 Markdown 格式强调重要元素，以引导读者更加层次分明地了解信息。

我们鼓励您在正确的地方使用告示 (Admonitions) (一种由 Docusaurus 提供的 MDX 特性），以提供清晰舒适的外观。您可以转到 admonitions 来了解更多.

请记住，请为步骤和其他方案使用正确的标题结构。例如，这看起来不太好：

1.  下载和安装
    1.1 安装 iNKORE Hub
    您可以通过使用 iNKORE Hub 快速便捷地安装我们的产品。如果您的计算机上尚未安装 iNKORE Hub，请单击下面的按钮...

    安装完 iNKORE Hub 后，您的开始菜单中应该会有一个类似这样的快捷方式。

    1.2 打开 iNKORE Hub 并下载 MCSkinn
    在开始菜单的程序中点击 "iNKORE Hub"。初始化后，点击左侧面板中的"产品"选

        如果弹出任何错误消息，您应该检查您的网络连接、防病毒软件和系统环境。如果这些方法都无效，请联系支持 ([email protected]) ，我们很乐意帮助。

2.  开始使用 MCSkinn
    2.1 准备工作
    在使用 MCSkinn 之前，您需要一个代表您皮肤库的目录。它可以是空的，也可以填充有您的个人皮肤...

这样写才能自动生成正确的目录结构：

## 步骤 1: 下载和安装

### 安装 iNKORE Hub

您可以通过使用 iNKORE Hub 快速便捷地安装我们的产品。如果您的计算机上尚未安装 iNKORE Hub，请单击下面的按钮...

### 打开 iNKORE Hub 并下载 MCSkinn

在开始菜单的程序中点击 "iNKORE Hub"。初始化后，点击左侧面板中的"产品"选
如果弹出任何错误消息，您应该检查您的设置。

## 步骤 2: 开始使用 MCSkinn

### 准备工作

在使用 MCSkinn 之前，您需要一个代表您皮肤库的目录。它可以是空的，也可以填充有您的个人皮肤...

语言特定细节

在汉字和拉丁字符之间一定要有一个空格

对于某些语言的文档 (如中文) 来说，字符、字母和符号的舞蹈遵循一种节奏，一定要注意在 [中文] 和 [英文/字母/数字/半角符号] 中使用空格。

总是使用英文标点符号 (有例外)

除逗号，句号，问号和冒号之外所有标点都请使用半角符号。所有括号也请使用半角符号，并在括号的外侧各添加一个空格。(斜线左右可以不加空格)。

日期和时间格式

对于短期日期，请使用 MM/dd/yyyy 格式 (例如 05/02/2024)。对于长期日期，它应该像 9 月 20 日，2023 年。

对于时间，请始终遵循 HH:mm 或 HH:mm:ss 规则 (例如 16:20，08:06:45)。军用时间 (24小时制) 将始终使用。

上述规则适用于所有文档和所有区域设置，无论文档是什么语言。

示例

例如，避免这样写：

2024.5.2 4:08 | 2nd May 2024 | 2024年5月2日下午4点8分
我买了34个苹果（是红的）和1只鸡【不知道是公鸡 / 还是 / 母鸡】。

相反，为了更好的可读性，请这样写：

05/02/2024 16:08 | May 2nd, 2024 | 5 月 2 日 2024 年，16:08
我买了 34 个苹果 (是红的) 和 1 只鸡 [不知道是公鸡/还是/母鸡]。

结尾

本指南旨在为 (潜在) 贡献者 (比如正在看这篇文章的你) 提供清晰而全面的文档结构概述。它涵盖了命名方式、文件架构以及编写文档的特定规则。

如果您有任何问题，可以在 Github issues 中开票提交问题，加入我们的社区，或通过电子邮件直接联系我们。如果有文章有哪里没讲清楚，也可以直接提交 Pull Request。我们非常感谢您的重要工作，这会使文档中心变得更好！



没错，这玩意是 AI 写的，又是用 AI 机翻的。欢迎玩各种翻译梗 (尽量保留原义，别太过分就行)。提示词如下：

请你用英语写一篇文章，大概讲述一下我们的文档库文件目录的结构和贡献须知，给那些想要来写文档的朋友们看。
请重新组织我的语言，让它看起来更流畅更易懂。我把文件结构放在图片里面了。

首先data目录下有docs和blog两个文件夹，blogs里面装的是我们工作室的公告和博客，不> 要动。
文档放在docs文件夹内，docs内就是产品的名称。这里面会有很多层级的文件夹。文件夹的命名格式如下：
如果是分类：01. category-name
如果是文章：02.# article-name
前面的数字是显示在侧边栏的序号，接下来有.作为分隔符。

如果这个文件夹是分类（里面有其他文章），那个就在点后面加空格并写分类的slug（采用kebab命名格式） ，
分类文件夹下应该有_category_.json，_category_.en-US.json，等，他们包含了这一分组的元数据。对于不同语言公用的元数据（比如此分类是否默认展开），就会在_category_.json中；对于语言特定的元数据（比如显示名称，描述），就在_category_.{语言代码}.json中。
这个文件中可以写的内容请详见：https://docusaurus.io/zh-CN/docs/sidebar/autogenerated#category-item-metadata

如果这个文件夹是单个文章，那么文件名在序号和点之后应该有一个#号，并且#和slug之间有空格。对于单个文章的文件夹，里面应该有index.meta.yml（单篇文章共用元数据），和内容index.{语言代号}.mdx（如index.en-US.mdx和index.zh-CN.mdx）。对于不同语言公用的元数据，就会在index.meta.yml中以yaml格式存储；队医单个语言特定的元数据，则存储在index.{语言代号}.mdx的front matter中。关于元数据请参见：https://docusaurus.io/zh-CN/docs/markdown-features#front-matter 和 https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs#markdown-front-matter。
文章中的图片应当和index.{..}.mdx存在同一目录内，并且以简短的kebab形式命名，比如 create-a-new-project.png。对于屏幕截图和其他较小的图片，请使用png格式，对于较大的图片，请使用jpg格式。

文章内采用mdx格式进行编写，建议积极使用MDX的特殊功能，如告示（https://docusaurus.io/zh-CN/docs/markdown-features/admonitions）。
请严格按照markdown的1-3级标题规划文章结构，并在合适的位置使用****，``，**，等markdown格式，这样能让读者更好地分清重点。

在编写中文文章时，请一定要注意在 [中文] 和 [英文/字母/数字/半角符号] 中使用空格。所有括号请使用半角符号，并在括号的外侧各添加一个空格。（斜线可以不加空格）
比如错误示范：2024年5月2日，我买了34个苹果（是红的）和1只鸡【不知道是公鸡 / 还是 / 母鸡】。
正确示范：2024 年 5 月 2 日，我买了 34 个苹果 (是红的) 和 1 只鸡 [不知道是公鸡/还是/母鸡]。