mirror of
https://gitee.com/huanghongxun/HMCL-docs.git
synced 2025-02-23 06:34:03 +08:00
feat: update readme
This commit is contained in:
parent
069b524c17
commit
2cddcb0a03
@ -21,7 +21,7 @@ Hello Minecraft! Launcher 帮助文档仓库
|
||||
|
||||
每篇文章结构如下:
|
||||
```
|
||||
<article>.md
|
||||
_<category>/<article>.md
|
||||
|
||||
assets
|
||||
* img
|
||||
@ -32,7 +32,7 @@ assets
|
||||
* ...
|
||||
```
|
||||
|
||||
其中,`<article>` 表示你的文章的英文名(尖括号表示占位符,请替换为文章名称,不要直接提交 '`<article>`'),请仅使用英文字母、数字、中划线、下划线字符,不要使用空格、中文字符。请确保 md 文件名和文件夹名一致。具体可以参考已有文章目录格式。
|
||||
其中,`<category>` 表示分类,如 `multiplayer` 表示多人游戏、`modpack` 表示整合包,`<article>` 表示你的文章的英文名(尖括号表示占位符,请替换为文章名称,不要直接提交 '`<article>`'),请仅使用英文字母、数字、中划线、下划线字符,不要使用空格、中文字符。请确保 md 文件名和文件夹名一致。具体可以参考已有文章目录格式。
|
||||
|
||||
每篇文章由 Markdown 编写的 `<article>.md` 文件及附带图片组成。文章的图片请放置到 `/assets/img/docs/<article>` 目录中。
|
||||
|
||||
@ -45,3 +45,7 @@ assets
|
||||
### 修改已有文章
|
||||
|
||||
修改已有文章时,请确保你的 PR 仅修改一个文章内容,并在该文章里署名。
|
||||
|
||||
### 更新索引
|
||||
|
||||
在添加或修改文章后,请更新索引文件 `index.json`,以便 HMCL 展示你新添加的文件。
|
||||
|
Loading…
Reference in New Issue
Block a user