From 2cddcb0a036b23b078cf1ba6e5fb76911e23483f Mon Sep 17 00:00:00 2001 From: Yuhui Huang Date: Thu, 5 May 2022 00:28:20 +0800 Subject: [PATCH] feat: update readme --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0cd8666..c8c2c81 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Hello Minecraft! Launcher 帮助文档仓库 每篇文章结构如下: ``` -
.md +_/
.md assets * img @@ -32,7 +32,7 @@ assets * ... ``` -其中,`
` 表示你的文章的英文名(尖括号表示占位符,请替换为文章名称,不要直接提交 '`
`'),请仅使用英文字母、数字、中划线、下划线字符,不要使用空格、中文字符。请确保 md 文件名和文件夹名一致。具体可以参考已有文章目录格式。 +其中,`` 表示分类,如 `multiplayer` 表示多人游戏、`modpack` 表示整合包,`
` 表示你的文章的英文名(尖括号表示占位符,请替换为文章名称,不要直接提交 '`
`'),请仅使用英文字母、数字、中划线、下划线字符,不要使用空格、中文字符。请确保 md 文件名和文件夹名一致。具体可以参考已有文章目录格式。 每篇文章由 Markdown 编写的 `
.md` 文件及附带图片组成。文章的图片请放置到 `/assets/img/docs/
` 目录中。 @@ -45,3 +45,7 @@ assets ### 修改已有文章 修改已有文章时,请确保你的 PR 仅修改一个文章内容,并在该文章里署名。 + +### 更新索引 + +在添加或修改文章后,请更新索引文件 `index.json`,以便 HMCL 展示你新添加的文件。