Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .drone.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ steps:
commands:
- bundle config mirror.https://rubygems.org https://mirrors.cloud.tencent.com/rubygems
- bundle install --verbose
- bundle exec jekyll build --trace --verbose
- bash build/setup.sh
volumes:
- name: dist
path: /drone/src/_site
Expand Down
37 changes: 25 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
# HMCL-docs

[![Build Status](https://drone.hmcl.net/api/badges/huanghongxun/HMCL-docs/status.svg)](https://drone.hmcl.net/huanghongxun/HMCL-docs)

Hello Minecraft! Launcher 帮助文档仓库

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

## 相关链接

[Hello Minecraft! Launcher 帮助文档仓库网站](https://docs.hmcl.net)
- [官方网站](https://hmcl.huangyuhui.net)
- [文档网站](https://docs.hmcl.net)
- [更新日志](https://docs.hmcl.net/changelog.html)
- [贡献指南](https://docs.hmcl.net/contribution.html)
- [项目仓库](https://github.com/HMCL-dev/HMCL)
- [文档仓库](https://github.com/HMCL-dev/HMCL-docs)

## Markdown

Expand All @@ -17,11 +25,13 @@ Hello Minecraft! Launcher 帮助文档仓库
请注意,你在使用 Typora 时,请在 文件->偏好设置->图像 中,将 `插入图片时...` 选项修改为复制到指定路径为 `/assets/img/docs/${filename}` 目录

## 贡献

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

每篇文章结构如下:

```
_<category>/<article>.md
_<collection>/<article>.md

assets
* img
Expand All @@ -32,20 +42,23 @@ assets
* ...
```

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

每篇文章由 Markdown 编写的 `<article>.md` 文件及附带图片组成。文章的图片请放置到 `/assets/img/docs/<article>` 目录中。
其中,`<collection>` 表示集合,如 `modpack` 表示整合包,`<article>` 表示你的文章的英文唯一标识(尖括号表示占位符,不要直接提交 `<article>`,请确保其唯一且简短)请仅使用英文字母、数字、中划线、下划线字符作为唯一标识,不要使用空格、英文句点、中文字符。请确保资源文件夹名和 md 文件名一致,具体可以参考已有文章目录格式。

### 添加新文章
每篇文章由 Markdown 编写的 `<article>.md` 文件及附带图片组成(文章的图片请放置到 `/assets/img/docs/<article>` 目录中)在 md 文件中请确保包含 [Front Matter](https://jekyllrb.com/docs/front-matter/) 其中应提供文章的一些元数据(如标题 `title` 更新日期 `date` 等)在 _config.yml 的 defaults 中配置有默认值的可以不指定。

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

切记不要在一个添加新文章的 PR 里修改其他文章的内容
添加文章时,请确保将内容按照上述格式要求存放,你也可以参考已经写好的文章格式。切记不要在一个添加新文章的 PR 里修改其他文章的内容

### 修改已有文章
### 修改文章

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

### 更新索引
你可以在文章的 [Front Matter](https://jekyllrb.com/docs/front-matter/) 中通过如下方式进行署名,其中 `author` 表示文章的创建者,`contributors` 是一个数组表示文章的贡献者。

在添加或修改文章后,请更新索引文件 `index.json`,以便 HMCL 展示你新添加的文件。
```yaml
---
author: example
contributors: [foo, bar]
---
```
4 changes: 4 additions & 0 deletions _changelog/dev.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Dev Change Log
channel: dev
---
14 changes: 1 addition & 13 deletions _changelog/dev.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,5 @@
---
title: 开发版更新日志
date: 2021-08-22 23:18:02 +0800
categories: 更新日志
note: Changelogs are written in Chinese.
hits: true
toc: true
channel: dev
---

{% assign changelogs = site.changelogs | where_exp: "item", "item.relative_path contains 'dev/'" | reverse %}
{% for item in changelogs %}
{% assign path = item.relative_path | split: '.' | first | split: '/' %}
{% assign end = path | size %}
{% assign version = path | slice: 2, end | join: '.' %}
<h1 id="{% if forloop.index == 1 %}nowchange{% else %}HMCL-{{ version }}{% endif %}">HMCL {{ version }}</h1>
<div>{{ item.content | markdownify }}</div>
{% endfor %}
4 changes: 4 additions & 0 deletions _changelog/dev.zh-TW.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 開髮版更新日誌
channel: dev
---
3 changes: 3 additions & 0 deletions _changelog/stable.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Stable Change Log
---
13 changes: 0 additions & 13 deletions _changelog/stable.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,4 @@
---
title: 稳定版更新日志
date: 2021-08-22 23:18:02 +0800
categories: 更新日志
note: Changelogs are written in Chinese.
hits: true
toc: true
---

{% assign changelogs = site.changelogs | where_exp: "item", "item.relative_path contains 'stable/'" | reverse %}
{% for item in changelogs %}
{% assign path = item.relative_path | split: '.' | first | split: '/' %}
{% assign end = path | size %}
{% assign version = path | slice: 2, end | join: '.' %}
<h1 id="{% if forloop.index == 1 %}nowchange{% else %}HMCL-{{ version }}{% endif %}">HMCL {{ version }}</h1>
<div>{{ item.content | markdownify }}</div>
{% endfor %}
3 changes: 3 additions & 0 deletions _changelog/stable.zh-TW.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: 穩定版更新日誌
---
20 changes: 20 additions & 0 deletions _changelogs/dev/3/7/0/300.zh-TW.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
---

詳細版本介紹: [cv43252149](https://www.bilibili.com/opus/1119832333534363699)

- GP-4215: 在啟動器中內置 Terracotta | 陶瓦聯機 (by Burning_TNT)
Terracotta | 陶瓦聯機 是第三方提供的開源免費聯機工具,基於 EasyTier 開源項目開髮。
我們基於該工具爲所有用戶免費提供開箱即用的聯機功能。
詳情請參見這篇文章: [HMCL x Terracotta | 陶瓦聯機全麵開放](https://www.bilibili.com/opus/1119528739516973063)
- GP-4566: 更新模組下載頁遊戲版本列表至 1.21.9 (by 3gf8jv4dv)
- GP-3229: 優化模組管理佈局 (by zkitefly)
- GP-4521: 支持通過環境變量控製 UI 縮放比例 (by Glavo)
- GP-4577: 優化對顛倒的英語的支持 (by Glavo)
- GP-4592: 更新中文(文言)環境中其他語言名稱的譯法 (by 3gf8jv4dv)

錯誤修複:

- GP-4568: 修複在短時間內連續點擊“行按鈕”隻會更改一次狀態的問題 (by 辞庐)
- GP-4571: 修複「外觀 - 不透明度」滑塊的刻度線在不同滑塊位置時排佈不統一的問題 (by 辞庐)
- GP-4583: 修複“不自動添加 Java 虛擬機優化參數”選項未保存至配置文件的問題 (by Glavo)
Loading