Skip to content

Commit e5b432a

Browse files
author
[email protected]
committed
docs(README): Add collapsible details sections for commands
- Introduce collapsible sections in the README for better organization. - Group related commands under 'details' to enhance readability. - Ensure each section provides relevant examples while maintaining a clean layout.
1 parent 0ece92c commit e5b432a

File tree

4 files changed

+115
-11
lines changed

4 files changed

+115
-11
lines changed

‎README-ja.md

+30-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# ai-commit
22

33
[//]: # (https://looka.com)
4+
45
[//]: # (<p align="center"><img src="resources/docs/logo.png" alt="logo" style="width: 62%; height: 62%;"></p>)
56
<p align="center"><img src="resources/docs/ai-commit-vhs.gif" alt="ai-commit-vhs"></p>
67

7-
[简体中文](README-zh_CN.md) | [ENGLISH](README.md) | [日本語](README-ja.md) | [繁體中文](README-zh_TW.md)
8+
[ENGLISH](README.md) | [日本語](README-ja.md) | [简体中文](README-zh_CN.md) | [繁體中文](README-zh_TW.md)
89

910
> Automagically generate conventional git commit message with AI. - 使用 AI 自动生成约定式 git 提交信息。
1011
@@ -52,11 +53,14 @@ composer require guanguans/ai-commit --dev -v # ローカル
5253

5354
### クイックスタート
5455

56+
<details>
57+
<summary>details</summary>
58+
5559
```shell
56-
./ai-commit config set generators.bito_cli.binary bito-cli-binary... --global # Config Bito cli binary(Optional)
60+
./ai-commit config set generators.bito_cli.binary bito-cli-binary... --global # Config Bito CLI binary(Optional)
5761
./ai-commit config set generators.ernie_bot.api_key api-key... --global # Config Ernie API key
5862
./ai-commit config set generators.ernie_bot_turbo.api_key api-key... --global # Config Ernie API key
59-
./ai-commit config set generators.github_copilot_cli.binary gh-cli-binary... --global # Config Github cli binary(Optional)
63+
./ai-commit config set generators.github_copilot_cli.binary gh-cli-binary... --global # Config Github CLI binary(Optional)
6064
./ai-commit config set generators.github_models_cli.binary gh-cli-binary... --global # Config Github CLI binary(Optional)
6165
./ai-commit config set generators.moonshot.api_key sk-... --global # Config Moonshot API key
6266
./ai-commit config set generators.openai.api_key sk-... --global # Config OpenAI API key
@@ -71,7 +75,7 @@ composer require guanguans/ai-commit --dev -v # ローカル
7175
╰─ ./ai-commit commit --generator=bito_cli --no-edit --no-verify --ansi ─╯
7276
1. Generating commit message: generating...
7377

74-
Please choice commit type [Automatically generate commit type]:
78+
Please choose commit type [Automatically generate commit type]:
7579
[auto ] Automatically generate commit type
7680
[feat ] A new feature
7781
[fix ] A bug fix
@@ -125,8 +129,13 @@ composer require guanguans/ai-commit --dev -v # ローカル
125129
126130
![](resources/docs/ai-commit-vhs.gif)
127131
132+
</details>
133+
128134
### コマンドの一覧
129135
136+
<details>
137+
<summary>details</summary>
138+
130139
```shell
131140
╰─ ./ai-commit list ─╯
132141
@@ -151,8 +160,13 @@ composer require guanguans/ai-commit --dev -v # ローカル
151160
thanks Thanks for using this tool.
152161
```
153162
163+
</details>
164+
154165
### 設定の操作
155166
167+
<details>
168+
<summary>details</summary>
169+
156170
```shell
157171
./ai-commit config [set, get, unset, reset, list, edit] key value --global
158172
@@ -164,8 +178,13 @@ composer require guanguans/ai-commit --dev -v # ローカル
164178
./ai-commit config edit
165179
```
166180
181+
</details>
182+
167183
### 自己更新
168184
185+
<details>
186+
<summary>details</summary>
187+
169188
```shell
170189
╰─ ./ai-commit self-update ─╯
171190
@@ -177,8 +196,13 @@ Checking for a new version...
177196
178197
```
179198
199+
</details>
200+
180201
### コマンドヘルプ
181202
203+
<details>
204+
<summary>details</summary>
205+
182206
```shell
183207
╰─ ./ai-commit commit --help ─╯
184208
Description:
@@ -211,6 +235,8 @@ Options:
211235
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
212236
```
213237
238+
</details>
239+
214240
## テスト
215241
216242
```shell

‎README-zh_CN.md

+30-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# ai-commit
22

33
[//]: # (https://looka.com)
4+
45
[//]: # (<p align="center"><img src="resources/docs/logo.png" alt="logo" style="width: 62%; height: 62%;"></p>)
56
<p align="center"><img src="resources/docs/ai-commit-vhs.gif" alt="ai-commit-vhs"></p>
67

7-
[简体中文](README-zh_CN.md) | [ENGLISH](README.md) | [日本語](README-ja.md) | [繁體中文](README-zh_TW.md)
8+
[ENGLISH](README.md) | [日本語](README-ja.md) | [简体中文](README-zh_CN.md) | [繁體中文](README-zh_TW.md)
89

910
> Automagically generate conventional git commit message with AI. - 使用 AI 自动生成约定式 git 提交信息。
1011
@@ -52,11 +53,14 @@ composer require guanguans/ai-commit --dev -v # 本地
5253

5354
### 快速开始
5455

56+
<details>
57+
<summary>details</summary>
58+
5559
```shell
56-
./ai-commit config set generators.bito_cli.binary bito-cli-binary... --global # Config Bito cli binary(Optional)
60+
./ai-commit config set generators.bito_cli.binary bito-cli-binary... --global # Config Bito CLI binary(Optional)
5761
./ai-commit config set generators.ernie_bot.api_key api-key... --global # Config Ernie API key
5862
./ai-commit config set generators.ernie_bot_turbo.api_key api-key... --global # Config Ernie API key
59-
./ai-commit config set generators.github_copilot_cli.binary gh-cli-binary... --global # Config Github cli binary(Optional)
63+
./ai-commit config set generators.github_copilot_cli.binary gh-cli-binary... --global # Config Github CLI binary(Optional)
6064
./ai-commit config set generators.github_models_cli.binary gh-cli-binary... --global # Config Github CLI binary(Optional)
6165
./ai-commit config set generators.moonshot.api_key sk-... --global # Config Moonshot API key
6266
./ai-commit config set generators.openai.api_key sk-... --global # Config OpenAI API key
@@ -71,7 +75,7 @@ composer require guanguans/ai-commit --dev -v # 本地
7175
╰─ ./ai-commit commit --generator=bito_cli --no-edit --no-verify --ansi ─╯
7276
1. Generating commit message: generating...
7377

74-
Please choice commit type [Automatically generate commit type]:
78+
Please choose commit type [Automatically generate commit type]:
7579
[auto ] Automatically generate commit type
7680
[feat ] A new feature
7781
[fix ] A bug fix
@@ -125,8 +129,13 @@ composer require guanguans/ai-commit --dev -v # 本地
125129
126130
![](resources/docs/ai-commit-vhs.gif)
127131
132+
</details>
133+
128134
### 列出命令
129135
136+
<details>
137+
<summary>details</summary>
138+
130139
```shell
131140
╰─ ./ai-commit list ─╯
132141
@@ -151,8 +160,13 @@ composer require guanguans/ai-commit --dev -v # 本地
151160
thanks Thanks for using this tool.
152161
```
153162
163+
</details>
164+
154165
### 操作配置
155166
167+
<details>
168+
<summary>details</summary>
169+
156170
```shell
157171
./ai-commit config [set, get, unset, reset, list, edit] key value --global
158172
@@ -164,8 +178,13 @@ composer require guanguans/ai-commit --dev -v # 本地
164178
./ai-commit config edit
165179
```
166180
181+
</details>
182+
167183
### 自我更新
168184
185+
<details>
186+
<summary>details</summary>
187+
169188
```shell
170189
╰─ ./ai-commit self-update ─╯
171190
@@ -177,8 +196,13 @@ Checking for a new version...
177196
178197
```
179198
199+
</details>
200+
180201
### 命令帮助
181202
203+
<details>
204+
<summary>details</summary>
205+
182206
```shell
183207
╰─ ./ai-commit commit --help ─╯
184208
Description:
@@ -211,6 +235,8 @@ Options:
211235
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
212236
```
213237
238+
</details>
239+
214240
## 测试
215241
216242
```shell

‎README-zh_TW.md

+28-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# ai-commit
22

33
[//]: # (https://looka.com)
4+
45
[//]: # (<p align="center"><img src="resources/docs/logo.png" alt="logo" style="width: 62%; height: 62%;"></p>)
56
<p align="center"><img src="resources/docs/ai-commit-vhs.gif" alt="ai-commit-vhs"></p>
67

7-
[简体中文](README-zh_CN.md) | [ENGLISH](README.md) | [日本語](README-ja.md) | [繁體中文](README-zh_TW.md)
8+
[ENGLISH](README.md) | [日本語](README-ja.md) | [简体中文](README-zh_CN.md) | [繁體中文](README-zh_TW.md)
89

910
> Automagically generate conventional git commit message with AI. - 使用 AI 自动生成约定式 git 提交信息。
1011
@@ -52,6 +53,9 @@ composer require guanguans/ai-commit --dev -v # 本地安裝
5253

5354
### 快速開始
5455

56+
<details>
57+
<summary>details</summary>
58+
5559
```shell
5660
./ai-commit config set generators.bito_cli.binary bito-cli-binary... --global # Config Bito CLI binary(Optional)
5761
./ai-commit config set generators.ernie_bot.api_key api-key... --global # Config Ernie API key
@@ -123,10 +127,15 @@ composer require guanguans/ai-commit --dev -v # 本地安裝
123127
124128
```
125129
126-
![](docs/ai-commit-vhs.gif)
130+
![](resources/docs/ai-commit-vhs.gif)
131+
132+
</details>
127133
128134
### 指令列表
129135
136+
<details>
137+
<summary>details</summary>
138+
130139
```shell
131140
╰─ ./ai-commit list ─╯
132141
@@ -151,8 +160,13 @@ composer require guanguans/ai-commit --dev -v # 本地安裝
151160
thanks Thanks for using this tool.
152161
```
153162
163+
</details>
164+
154165
### 設定操作
155166
167+
<details>
168+
<summary>details</summary>
169+
156170
```shell
157171
./ai-commit config [set, get, unset, reset, list, edit] key value --global
158172
@@ -164,8 +178,13 @@ composer require guanguans/ai-commit --dev -v # 本地安裝
164178
./ai-commit config edit
165179
```
166180
181+
</details>
182+
167183
### 自動更新
168184
185+
<details>
186+
<summary>details</summary>
187+
169188
```shell
170189
╰─ ./ai-commit self-update ─╯
171190
@@ -177,8 +196,13 @@ Checking for a new version...
177196
178197
```
179198
199+
</details>
200+
180201
### 指令說明
181202
203+
<details>
204+
<summary>details</summary>
205+
182206
```shell
183207
╰─ ./ai-commit commit --help ─╯
184208
Description:
@@ -211,6 +235,8 @@ Options:
211235
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
212236
```
213237
238+
</details>
239+
214240
## 測試
215241
216242
```shell

‎README.md

+27-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# ai-commit
22

33
[//]: # (https://looka.com)
4+
45
[//]: # (<p align="center"><img src="resources/docs/logo.png" alt="logo" style="width: 62%; height: 62%;"></p>)
56
<p align="center"><img src="resources/docs/ai-commit-vhs.gif" alt="ai-commit-vhs"></p>
67

7-
[简体中文](README-zh_CN.md) | [ENGLISH](README.md) | [日本語](README-ja.md) | [繁體中文](README-zh_TW.md)
8+
[ENGLISH](README.md) | [日本語](README-ja.md) | [简体中文](README-zh_CN.md) | [繁體中文](README-zh_TW.md)
89

910
> Automagically generate conventional git commit message with AI. - 使用 AI 自动生成约定式 git 提交信息。
1011
@@ -52,6 +53,9 @@ composer require guanguans/ai-commit --dev -v # local
5253

5354
### Quick start
5455

56+
<details>
57+
<summary>details</summary>
58+
5559
```shell
5660
./ai-commit config set generators.bito_cli.binary bito-cli-binary... --global # Config Bito CLI binary(Optional)
5761
./ai-commit config set generators.ernie_bot.api_key api-key... --global # Config Ernie API key
@@ -125,8 +129,13 @@ composer require guanguans/ai-commit --dev -v # local
125129
126130
![](resources/docs/ai-commit-vhs.gif)
127131
132+
</details>
133+
128134
### List commands
129135
136+
<details>
137+
<summary>details</summary>
138+
130139
```shell
131140
╰─ ./ai-commit list ─╯
132141
@@ -151,8 +160,13 @@ composer require guanguans/ai-commit --dev -v # local
151160
thanks Thanks for using this tool.
152161
```
153162
163+
</details>
164+
154165
### Operate config
155166
167+
<details>
168+
<summary>details</summary>
169+
156170
```shell
157171
./ai-commit config [set, get, unset, reset, list, edit] key value --global
158172
@@ -164,8 +178,13 @@ composer require guanguans/ai-commit --dev -v # local
164178
./ai-commit config edit
165179
```
166180
181+
</details>
182+
167183
### Self update
168184
185+
<details>
186+
<summary>details</summary>
187+
169188
```shell
170189
╰─ ./ai-commit self-update ─╯
171190
@@ -177,8 +196,13 @@ Checking for a new version...
177196
178197
```
179198
199+
</details>
200+
180201
### Command help
181202
203+
<details>
204+
<summary>details</summary>
205+
182206
```shell
183207
╰─ ./ai-commit commit --help ─╯
184208
Description:
@@ -211,6 +235,8 @@ Options:
211235
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
212236
```
213237
238+
</details>
239+
214240
## Testing
215241
216242
```shell

0 commit comments

Comments
 (0)