From af3241b773c41b9c05ec0e121b99f83daeb18fc8 Mon Sep 17 00:00:00 2001 From: Gabe Date: Fri, 31 Oct 2025 23:12:27 +0800 Subject: [PATCH] doc: readme --- README.en.md | 81 ++++++++++++++++++---------------------------------- README.md | 55 +++++++++++------------------------ 2 files changed, 43 insertions(+), 93 deletions(-) diff --git a/README.en.md b/README.en.md index 2e1c929..969c5d1 100644 --- a/README.en.md +++ b/README.en.md @@ -1,40 +1,5 @@ # KISS Translator -**New Version Preview:** - -After a period of intermittent development, the planned features for the new version are essentially complete. The main new features are as follows: - -* **Core Translation Logic Refactoring:** - * Supports both automatic text detection and manual selection modes. - * The automatic text detection mode enables complete translation for the vast majority of websites without the need to write specific rules. - * The previous manual rule mode has been retained for meticulous optimization on specific websites. - * Supports rich text translation, preserving links and other text styles from the original content as much as possible. - * Optimize the display effect of showing only translated text (hiding original text). - -* **API Refactoring:** - * Supports adding and deleting an arbitrary number of APIs. - * Supports aggregating text for sending, reducing the number of calls to the translation API and improving performance. - * Supports the built-in Chrome AI translation API, enabling AI-powered translation without an internet connection. - * Supports AI contextual conversation memory to enhance translation quality. - * All APIs support advanced features such as hooks and custom parameters. - * Added support for Azure AI translation interface. - -* **Optimized YouTube Subtitle Support:** - * Supports translating video subtitles with any translation service and displaying them bilingually. - * Includes a built-in basic algorithm for subtitle merging and sentence splitting to improve translation results. - * Supports an AI-powered sentence splitting function to further enhance translation quality. - -* **English Dictionary Redundancy:** - * Added Bing and Youdao dictionaries. - * Fixed the vocabulary collection feature. - -* **User Experience Optimization:** - * The pop-up translation box for selected text now supports simultaneous translation by multiple services. - * The translation control panel has been updated with many new quick-toggle functions. - * Added a Playground page for convenient API debugging. - -**Note:** Due to extensive refactoring, the configuration file for the new version is not backward compatible with the old version. Therefore, please back up your data manually before upgrading. Furthermore, **do not import old configuration files after upgrading to the new version.** - English | [简体中文](README.md) A simple, open source [bilingual translation extension & Greasemonkey script](https://github.com/fishjar/kiss-translator). @@ -57,27 +22,35 @@ A simple, open source [bilingual translation extension & Greasemonkey script](ht - [x] Tencent/Volcengine - [x] OpenAI/Gemini/Claude/Ollama/DeepSeek/OpenRouter - [x] DeepL/DeepLX/NiuTrans - - [x] BuiltinAI/AzureAI/CloudflareAI - - [x] Custom translation interface + - [x] AzureAI / CloudflareAI + - [x] Chrome built-in AI translation (BuiltinAI) - [x] Covers common translation scenarios - - [x] Web bilingual translation - - [x] Input box translation - - [x] Seletction translation - - [x] Open the translation box on any page - - [x] Favorite Words - - [x] Mouseover translation + - [x] Webpage bilingual translation + - [x] Input-box translation + - Instantly translate text in input fields into other languages via shortcut keys + - [x] Text selection translation + - [x] Open translation popup on any page, support multiple translation services for comparison + - [x] English dictionary lookup + - [x] Save vocabulary + - [x] Hover translation - [x] YouTube subtitle translation - - [x] Support for various translation effects - - [x] Customizable text recognition and full-text translation - - [x] Customizable translation styles - - [x] Support for rich text translation and display - - [x] Support for displaying only the translated text (hiding the original text) - - [x] Advanced translation API features - - [x] Aggregate and send translated texts in batches - - [x] AI contextual conversation memory - - [x] Customizable AI terminology dictionary - - [x] AI-powered subtitle segmentation and translation - - [x] Customizable hooks and parameters + - Support translating video subtitles with any translation service and display bilingually + - Built-in basic subtitle merging and sentence-splitting algorithm to improve translation quality + - Supports AI-powered sentence segmentation for even better translation + - Custom subtitle style +- [x] Supports diverse translation modes + - [x] Supports both automatic text recognition and manual rule modes + - Automatic text recognition mode allows most sites to be translated fully without writing rules + - Manual rule mode enables extreme optimization for specific sites + - [x] Custom translation styling + - [x] Supports rich-text translation and rendering, preserving links and other text styles where possible + - [x] Option to show only translation (hide original text) +- [x] Advanced translation API features + - [x] With custom API support, theoretically works with any translation service + - [x] Batch aggregation of translation requests + - [x] Supports AI conversation context memory to improve translation quality + - [x] Custom AI terminology dictionary + - [x] All APIs support hooks and custom parameters for advanced usage - [x] Cross-client data synchronization - [x] KISS-Worker（cloudflare/docker） - [x] WebDAV diff --git a/README.md b/README.md index 3292477..0e7fb1a 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,5 @@ # 简约翻译 -> **新版预告**： -> -> 经过一段时间断续开发，新版的预期功能已基本完成，主要引入的新特性如下： -> -> - 核心翻译逻辑重构： -> - 支持自动识别文本与手动选择两种模式。 -> - 自动识别文本模式使得绝大部分网站无需编写规则也能翻译完整。 -> - 保留之前的手动规则模式，可以针对特定网站极致优化。 -> - 支持富文本翻译，能够尽量保留原文中的链接及其他文本样式。 -> - 优化仅显示译文（隐藏原文）显示效果。 -> - 接口重构： -> - 支持添加、删除任意数量的接口。 -> - 支持聚合发送文本，减少翻译接口调用次数，提升性能。 -> - 支持chrome内置AI翻译接口，无需通过网络即可实现AI翻译。 -> - 支持AI上下文会话记忆功能，提升翻译效果。 -> - 所有接口均支持Hook和自定义参数等高级功能。 -> - 新增Azure AI翻译接口支持 -> - 优化 YouTube 字幕支持： -> - 支持任意翻译服务对视频字幕进行翻译并双语显示。 -> - 内置基础的字幕合并与断句算法，提升翻译效果。 -> - 支持AI断句功能，可进一步提升翻译质量。 -> - 英文词典备灾： -> - 新增bing、有道词典。 -> - 修复词汇收藏功能。 -> - 用户操作优化： -> - 划词翻译框支持多种翻译服务同时翻译。 -> - 翻译控制面板新增许多快捷切换功能。 -> - 新增Playground页面，方便调试接口。 -> -> 注意：由于经过大量重构，使得新版配置文件很难与旧版兼容，因此在升级前请手动备份相关数据。并且，**升级新版后，勿再导入旧版配置**。 - [English](README.en.md) | 简体中文 一个简约、开源的 [双语对照翻译扩展 & 油猴脚本](https://github.com/fishjar/kiss-translator)。 @@ -53,27 +22,35 @@ - [x] Tencent/Volcengine - [x] OpenAI/Gemini/Claude/Ollama/DeepSeek/OpenRouter - [x] DeepL/DeepLX/NiuTrans - - [x] BuiltinAI/AzureAI/CloudflareAI - - [x] 自定义翻译接口 + - [x] AzureAI/CloudflareAI + - [x] Chrome浏览器内置AI翻译(BuiltinAI) - [x] 覆盖常见翻译场景 - [x] 网页双语对照翻译 - [x] 输入框翻译 + - 通过快捷键立即将输入框内文本翻译成其他语言 - [x] 划词翻译 - - [x] 任意页面打开翻译框 + - [x] 任意页面打开翻译框，可用多种翻译服务对比翻译 + - [x] 英文词典翻译 - [x] 收藏词汇 - [x] 鼠标悬停翻译 - [x] YouTube 字幕翻译 + - 支持任意翻译服务对视频字幕进行翻译并双语显示 + - 内置基础的字幕合并与断句算法，提升翻译效果 + - 支持AI断句功能，可进一步提升翻译质量 + - 自定义字幕样式 - [x] 支持多样翻译效果 - - [x] 自定识别文本，全文翻译 + - [x] 支持自动识别文本与手动规则两种模式 + - 自动识别文本模式使得绝大部分网站无需编写规则也能翻译完整 + - 手动规则模式，可以针对特定网站极致优化 - [x] 自定义译文样式 - - [x] 支持富文本翻译及显示 + - [x] 支持富文本翻译及显示，能够尽量保留原文中的链接及其他文本样式 - [x] 支持仅显示译文（隐藏原文） - [x] 翻译接口高级功能 + - [x] 通过自定义接口，理论上支持任何翻译接口 - [x] 聚合批量发送翻译文本 - - [x] AI上下文会话记忆 + - [x] 支持AI上下文会话记忆功能，提升翻译效果 - [x] 自定义AI术语词典 - - [x] 字幕文本AI智能断句及翻译 - - [x] 自定义Hook，自定义参数 + - [x] 所有接口均支持Hook和自定义参数等高级功能 - [x] 跨客户端数据同步 - [x] KISS-Worker（cloudflare/docker） - [x] WebDAV