Skip to content

Commit 849a434

Browse files
committed
docs: add Table of Contents to all README translations
- Add a Table of Contents section to the README files in English, Simplified Chinese, and Traditional Chinese for improved navigation. Signed-off-by: appleboy <[email protected]>
1 parent c07aa8d commit 849a434

File tree

3 files changed

+83
-0
lines changed

3 files changed

+83
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,36 @@
88

99
English | [繁體中文](./README.zh-tw.md) | [简体中文](./README.zh-cn.md)
1010

11+
## Table of Contents
12+
13+
- [CodeGPT](#codegpt)
14+
- [Table of Contents](#table-of-contents)
15+
- [Features](#features)
16+
- [Installation](#installation)
17+
- [macOS](#macos)
18+
- [Windows](#windows)
19+
- [Pre-compiled Binaries](#pre-compiled-binaries)
20+
- [From Source](#from-source)
21+
- [Using vscode devcontainer](#using-vscode-devcontainer)
22+
- [Configuration](#configuration)
23+
- [How to Customize the Default Prompt Folder](#how-to-customize-the-default-prompt-folder)
24+
- [How to Change to Azure OpenAI Service](#how-to-change-to-azure-openai-service)
25+
- [Support for Gemini API Service](#support-for-gemini-api-service)
26+
- [Support for Anthropic API Service](#support-for-anthropic-api-service)
27+
- [How to Change to Groq API Service](#how-to-change-to-groq-api-service)
28+
- [How to Change to Ollama API Service](#how-to-change-to-ollama-api-service)
29+
- [How to Change to OpenRouter API Service](#how-to-change-to-openrouter-api-service)
30+
- [Usage](#usage)
31+
- [CLI Mode](#cli-mode)
32+
- [Change Commit Message Template](#change-commit-message-template)
33+
- [Git Hook](#git-hook)
34+
- [Install](#install)
35+
- [Uninstall](#uninstall)
36+
- [Code Review](#code-review)
37+
- [Testing](#testing)
38+
- [Star History](#star-history)
39+
- [Reference](#reference)
40+
1141
A CLI tool written in [Go](https://go.dev) that generates git commit messages or provides code review summaries using ChatGPT AI (gpt-4o, gpt-4 model). It also automatically installs a [git prepare-commit-msg hook](https://git-scm.com/docs/githooks).
1242

1343
- [繁體中文介紹][1]

README.zh-cn.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,29 @@
88

99
[English](./README.md) | [繁體中文](./README.zh-tw.md) | 简体中文
1010

11+
## 目录
12+
13+
- [CodeGPT](#codegpt)
14+
- [目录](#目录)
15+
- [功能](#功能)
16+
- [安装](#安装)
17+
- [从源码安装](#从源码安装)
18+
- [使用 VSCode Devcontainer](#使用-vscode-devcontainer)
19+
- [配置](#配置)
20+
- [如何自定义默认提示文件夹](#如何自定义默认提示文件夹)
21+
- [如何切换到 Azure OpenAI 服务](#如何切换到-azure-openai-服务)
22+
- [支持 Gemini API 服务](#支持-gemini-api-服务)
23+
- [支持 Anthropic API 服务](#支持-anthropic-api-服务)
24+
- [如何切换到 Groq API 服务](#如何切换到-groq-api-服务)
25+
- [如何切换到 ollama API 服务](#如何切换到-ollama-api-服务)
26+
- [如何切换到 OpenRouter API 服务](#如何切换到-openrouter-api-服务)
27+
- [使用](#使用)
28+
- [CLI 模式](#cli-模式)
29+
- [更改提交信息模板](#更改提交信息模板)
30+
- [Git hook](#git-hook)
31+
- [安装 hook](#安装-hook)
32+
- [卸载 hook](#卸载-hook)
33+
1134
一个用 [Go](https://go.dev) 编写的 CLI 工具,它使用 ChatGPT AI(gpt-4o,gpt-4 模型)为你编写 git 提交信息或提供代码审查摘要,并自动安装 [git prepare-commit-msg hook](https://git-scm.com/docs/githooks)
1235

1336
- [繁體中文介紹][1]

README.zh-tw.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,36 @@
88

99
[English](./README.md) | 繁體中文 | [简体中文](./README.zh-cn.md)
1010

11+
## 目錄
12+
13+
- [CodeGPT](#codegpt)
14+
- [目錄](#目錄)
15+
- [功能](#功能)
16+
- [安裝](#安裝)
17+
- [macOS](#macos)
18+
- [Windows](#windows)
19+
- [預編譯二進制文件](#預編譯二進制文件)
20+
- [從源碼安裝](#從源碼安裝)
21+
- [使用 VSCode Devcontainer](#使用-vscode-devcontainer)
22+
- [配置](#配置)
23+
- [如何自定義默認提示文件夾](#如何自定義默認提示文件夾)
24+
- [如何切換到 Azure OpenAI 服務](#如何切換到-azure-openai-服務)
25+
- [支援 Gemini API 服務](#支援-gemini-api-服務)
26+
- [支援 Anthropic API 服務](#支援-anthropic-api-服務)
27+
- [如何切換到 Groq API 服務](#如何切換到-groq-api-服務)
28+
- [如何切換到 Ollama API 服務](#如何切換到-ollama-api-服務)
29+
- [如何切換到 OpenRouter API 服務](#如何切換到-openrouter-api-服務)
30+
- [使用方法](#使用方法)
31+
- [CLI 模式](#cli-模式)
32+
- [更改提交訊息模板](#更改提交訊息模板)
33+
- [Git Hook](#git-hook)
34+
- [Install(安裝)](#install安裝)
35+
- [Uninstall(解除安裝)](#uninstall解除安裝)
36+
- [程式碼審查(Code Review)](#程式碼審查code-review)
37+
- [測試(Testing)](#測試testing)
38+
- [Star History](#star-history)
39+
- [參考資料(Reference)](#參考資料reference)
40+
1141
一個用 [Go](https://go.dev) 編寫的 CLI 工具,使用 ChatGPT AI (gpt-4o, gpt-4 模型) 生成 git 提交訊息或提供代碼審查摘要。它還會自動安裝 [git prepare-commit-msg hook](https://git-scm.com/docs/githooks)
1242

1343
- [繁體中文介紹][1]

0 commit comments

Comments
 (0)