From 13a7b26d2183ec18a613899ad56b3d930a3dc6d5 Mon Sep 17 00:00:00 2001 From: M1hono Date: Thu, 5 Sep 2024 05:27:20 +1000 Subject: [PATCH] Sync Gumeng's Change. --- .../KubejsCourse/KubejsBasic/FileStructure.md | 8 ++++--- docs/zh/modpack/kubejs/KubejsCourse/README.md | 22 ++++++++++++------- 2 files changed, 19 insertions(+), 11 deletions(-) diff --git a/docs/zh/modpack/kubejs/KubejsCourse/KubejsBasic/FileStructure.md b/docs/zh/modpack/kubejs/KubejsCourse/KubejsBasic/FileStructure.md index ecee2c90..ef3bc695 100644 --- a/docs/zh/modpack/kubejs/KubejsCourse/KubejsBasic/FileStructure.md +++ b/docs/zh/modpack/kubejs/KubejsCourse/KubejsBasic/FileStructure.md @@ -1,4 +1,4 @@ -## 认识KubeJS的文件夹 +# 认识KubeJS的文件夹 kjs在第一次运行后，会在版本文件夹下创建一个自己的魔改文件夹 **`kubejs`** ，在该文件夹里有 \ **`assets`**\ @@ -10,7 +10,7 @@ kjs在第一次运行后，会在版本文件夹下创建一个自己的魔改 这些文件夹，下面会介绍这些文件夹所存放的类型 -### 资源Assets +## 资源Assets **`assets`** 其结构如下所示assets/\/... @@ -25,7 +25,7 @@ kjs在第一次运行后，会在版本文件夹下创建一个自己的魔改 type="info" > -### 数据Data +## 数据Data **`data`** 其结构如下所示data/\/... @@ -76,6 +76,8 @@ kjs在第一次运行后，会在版本文件夹下创建一个自己的魔改 2. [Global Data & Resourcepacks](https://www.mcmod.cn/class/2826.html) 3. [Json Things](https://www.mcmod.cn/class/7734.html) +## 配置文件 + **`config`** 是存放配置文件的，可以自己定义一些配置文件丢里面 > **只限于KubeJS自己所提供的配置文件, 例如图标和窗口标题的修改等** diff --git a/docs/zh/modpack/kubejs/KubejsCourse/README.md b/docs/zh/modpack/kubejs/KubejsCourse/README.md index e3c96321..75606af2 100644 --- a/docs/zh/modpack/kubejs/KubejsCourse/README.md +++ b/docs/zh/modpack/kubejs/KubejsCourse/README.md @@ -17,22 +17,28 @@ 项目[问题反馈](https://gitee.com/gumengmengs/kubejs-course/issues/new/choose) -# 关于一些文件夹的帮助 -## 文件夹分类 -* KubejsBasic 存放kubejs基础内容 +# 关于编写文档 +## 编写文档要求 +1. 文件和文件夹首字母为大写 +2. 所有新建文件需要在SUMMARY内进行编写目录 +3. 文档内容必须明确主题，不要一会儿这个一会儿那个的 +4. 文档需要简单通俗易懂，如果有什么专有名词需要花大段去解释就放到题外话里 +## 关于文档文件夹 +* KubeJS-Basics 存放kubejs基础内容 * KubejsAdvanced 存放kubejs的进阶内容 * KubejsAddon 存放关于kubejs周边的联动模组内容 -* Digression 存放除了kubejs代码以外可能需要知道的内容 +* Digression 题外话——存放除了kubejs代码以外可能需要知道的内容 * Texture 存放关于assets资源内容 * KubejsProjects 存放一些大家写的项目(对应的文件夹路径代表着对应的分享人) * Files 存放着文档里出现的可下载资源 -* imgs 存放着文档里出现的图片,对应的路径代表着出现的位置 +* imgs 存放着文档里出现的图片,对应的路径代表着出现的位置(使用绝对路径) * Code 存放着代码分享 * Projects是项目分享的代码 * This是教程中会涉及到的一些文件 -* 提交 - * 在表格中有着`-` `~`和`?`三种类型, 其中`-`代表无, `~`代表待编辑, `?`代表不知道 - * 在提交和编写的时候注意一下不要修改 + * 你也可以自己新建文件夹作为分类,文件夹需和文档名称一样 +## 关于文档一些规则 +* 文档内表格存在三种类型`-` `~`和`?`, 其中`-`代表无, `~`代表待编辑, `?`代表不知道 +* 图片一定要使用**绝对路径**