Go to file
2025-10-14 20:43:52 +08:00
_changelog 优化配置 (#283) 2025-10-14 20:43:52 +08:00
_changelogs 拆分更新日志到独立文件 (#277) 2025-10-14 11:27:55 +08:00
_data Revert "拆分更新日志到独立文件" (#275) 2025-10-13 16:42:24 +08:00
_docs 优化配置 (#283) 2025-10-14 20:43:52 +08:00
_downloads 优化配置 (#283) 2025-10-14 20:43:52 +08:00
_eula 优化配置 (#283) 2025-10-14 20:43:52 +08:00
_includes/head Fix minor issues (#258) 2025-10-03 12:42:13 +08:00
_launcher 优化配置 (#283) 2025-10-14 20:43:52 +08:00
_layouts 更新布局 document (#282) 2025-10-14 18:29:25 +08:00
_modpack 优化配置 (#283) 2025-10-14 20:43:52 +08:00
_multiplayer 优化配置 (#283) 2025-10-14 20:43:52 +08:00
_pages Revert "拆分更新日志到独立文件" (#275) 2025-10-13 16:42:24 +08:00
.github/workflows Update gitee.yml (#110) 2024-05-02 16:23:30 +08:00
assets 添加 logo (#281) 2025-10-14 18:27:02 +08:00
_config.yml 优化配置 (#283) 2025-10-14 20:43:52 +08:00
.drone.yml 优化构建流程 (#271) 2025-10-06 09:53:20 +08:00
.gitignore HMCL 3.5.6.240 更新日志 (#90) 2024-03-06 21:43:47 +08:00
favicon.ico 更新加群入口 (#98) 2024-03-21 12:25:54 +08:00
Gemfile 优化构建流程 (#271) 2025-10-06 09:53:20 +08:00
index.json 移除“多人联机维护”帮助项 (#266) 2025-10-04 08:43:52 +08:00
index.md 优化配置 (#283) 2025-10-14 20:43:52 +08:00
LICENSE change license to Attribution-NonCommercial-ShareAlike 4.0 International with additional license 2021-10-09 23:44:28 +08:00
README.md 更新 README.md 2024-02-07 01:27:24 +08:00

HMCL-docs

Hello Minecraft! Launcher 帮助文档仓库

您可以通过对本仓库提交 Pull Request 的方式来为 HMCL 帮助文档贡献自己的力量! 本仓库内容使用 Attribution-NonCommercial 4.0 International (CC BY-NC 4.0) 协议(附带额外条款)开放,协议内容请参见 LICENSE 文件。

相关链接

Hello Minecraft! Launcher 帮助文档仓库网站

Markdown

每篇文章由 Markdown 编写。如果你不知道什么是 Markdown我们推荐你先大概了解一下这个排版工具。

我们推荐你使用 Typora 编写 Markdown 文章,该软件的使用方法和 Word 等传统文字排版软件相似,易于使用。

请注意,你在使用 Typora 时,请在 文件->偏好设置->图像 中,将 插入图片时... 选项修改为复制到指定路径为 /assets/img/docs/${filename} 目录

贡献

本仓库组织方式为一篇文章放在一个目录中。如果你要提交 PR请不要将 md 文件直接放在根目录下。

每篇文章结构如下:

_<category>/<article>.md

assets
 * img
   * docs
     * <article>
       * img1.png
       * img2.png
       * ...

其中,<category> 表示分类,如 multiplayer 表示多人游戏、modpack 表示整合包,<article> 表示你的文章的英文名(尖括号表示占位符,请替换为文章名称,不要直接提交 '<article>'),请仅使用英文字母、数字、中划线、下划线字符,不要使用空格、中文字符。请确保 md 文件名和文件夹名一致。具体可以参考已有文章目录格式。

每篇文章由 Markdown 编写的 <article>.md 文件及附带图片组成。文章的图片请放置到 /assets/img/docs/<article> 目录中。

添加新文章

添加新文章时,请确保将内容按照上述格式要求存放。你也可以参考已经写好的文章格式。

切记不要在一个添加新文章的 PR 里修改其他文章的内容。

修改已有文章

修改已有文章时,请确保你的 PR 仅修改一个文章内容,并在该文章里署名。

更新索引

在添加或修改文章后,请更新索引文件 index.json,以便 HMCL 展示你新添加的文件。