From 3a3f1fabe16a3ae54e596df0d2c26e60f2b2fdce Mon Sep 17 00:00:00 2001 From: Gabe Date: Sat, 9 Aug 2025 11:41:24 +0800 Subject: [PATCH] doc: update readme --- README.en.md | 35 ++++++++++++++++++++++++++++++----- README.md | 32 +++++++++++++++++++++++++++----- 2 files changed, 57 insertions(+), 10 deletions(-) diff --git a/README.en.md b/README.en.md index 6cb1e0f..56855fd 100644 --- a/README.en.md +++ b/README.en.md @@ -13,8 +13,9 @@ A simple, open source [bilingual translation extension & Greasemonkey script](ht - [x] Adapt to common browsers - [x] Chrome/Edge/Firefox/Kiwi/Orion - [ ] Safari + - [x] Thunderbird - [x] Supports multiple translation services - - [x] Google/Microsoft/DeepL/NiuTrans/OpenAI/Gemini/CloudflareAI/Baidu/Tencent + - [x] Google/Microsoft/DeepL/NiuTrans/OpenAI/Gemini/Ollama/CloudflareAI/Baidu/Tencent/Claude/Volcengine - [x] Custom translation interface - [x] Covers common translation scenarios - [x] Web bilingual translation @@ -52,6 +53,7 @@ A simple, open source [bilingual translation extension & Greasemonkey script](ht - [x] Edge [Installation address](https://microsoftedge.microsoft.com/addons/detail/%E7%AE%80%E7%BA%A6%E7%BF%BB%E8%AF%91/jemckldkclkinpjighnoilpbldbdmmlh?hl=zh-CN) - [x] Firefox [Installation address](https://addons.mozilla.org/zh-CN/firefox/addon/kiss-translator/) - [ ] Safari + - [x] Thunderbird [Download address](https://github.com/fishjar/kiss-translator/releases) - [x] GreaseMonkey Script - [x] Chrome/Edge/Firefox ([Tampermonkey](https://www.tampermonkey.net/)/[Violentmonkey](https://violentmonkey.github.io/)) [Installation link](https://fishjar.github.io/kiss-translator/kiss-translator.user.js) - [Greasy Fork](https://greasyfork.org/zh-CN/scripts/472840-kiss-translator) @@ -69,10 +71,33 @@ A simple, open source [bilingual translation extension & Greasemonkey script](ht - Translation interface agent: [https://github.com/fishjar/kiss-proxy](https://github.com/fishjar/kiss-proxy) - If you encounter network problems when accessing a certain translation interface, this proxy service may help you. - Deploy and manage by yourself. -- Minimalistic Dictionary Plugin: [https://github.com/fishjar/kiss-dictionary](https://github.com/fishjar/kiss-dictionary) - - A word-marking translation plug-in used with this project. - - Supports query of English words, sentences and Chinese characters. - - Supports history records and word collections. + +## Frequently Asked Questions + +### Why are some web pages not fully translated? + +> This extension's webpage translation is based on CSS selectors. Generic rules cannot adapt to all websites, and sometimes you need to manually add site-specific rules. If you don't know how to write rules, you can seek help here: +https://github.com/fishjar/kiss-rules/issues + +### What is the priority order of rule settings? + +> Personal Rules > Override Subscription Rules > Subscription Rules > Global Rules +> Among these, Global Rules have the lowest priority but are very important as they serve as the default rules. + +### Why are YouTube subtitles translated in broken sentences? + +> This extension has no special development for video content. Support for YouTube is also treated as regular webpage translation. Auto-generated subtitles are streamed and output progressively, resulting in poorer support. +> To disable this extension's subtitle translation, add a rule. Reference: +https://github.com/fishjar/kiss-translator/issues/62 + +### Local Ollama interface cannot be used + +> If encountering a 403 error, refer to: +https://github.com/fishjar/kiss-translator/issues/174 + +### Custom API doesn't work in Tampermonkey scripts + +> Tampermonkey scripts require adding domains to the whitelist; otherwise, requests cannot be sent. ## Development Guidelines diff --git a/README.md b/README.md index 9d783b3..e863c71 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,9 @@ - [x] 适配常见浏览器 - [x] Chrome/Edge/Firefox/Kiwi/Orion - [ ] Safari + - [x] Thunderbird - [x] 支持多种翻译服务 - - [x] Google/Microsoft/DeepL/NiuTrans/OpenAI/Gemini/CloudflareAI/Baidu/Tencent + - [x] Google/Microsoft/DeepL/NiuTrans/OpenAI/Gemini/Ollama/CloudflareAI/Baidu/Tencent/Claude/Volcengine - [x] 自定义翻译接口 - [x] 覆盖常见翻译场景 - [x] 网页双语对照翻译 @@ -52,6 +53,7 @@ - [x] Edge [安装地址](https://microsoftedge.microsoft.com/addons/detail/%E7%AE%80%E7%BA%A6%E7%BF%BB%E8%AF%91/jemckldkclkinpjighnoilpbldbdmmlh?hl=zh-CN) - [x] Firefox [安装地址](https://addons.mozilla.org/zh-CN/firefox/addon/kiss-translator/) - [ ] Safari + - [x] Thunderbird [下载地址](https://github.com/fishjar/kiss-translator/releases) - [x] 油猴脚本 - [x] Chrome/Edge/Firefox ([Tampermonkey](https://www.tampermonkey.net/)/[Violentmonkey](https://violentmonkey.github.io/)) [安装链接](https://fishjar.github.io/kiss-translator/kiss-translator.user.js) - [Greasy Fork](https://greasyfork.org/zh-CN/scripts/472840-kiss-translator) @@ -69,10 +71,30 @@ - 翻译接口代理: [https://github.com/fishjar/kiss-proxy](https://github.com/fishjar/kiss-proxy) - 如果访问某个翻译接口遇到网络问题，这个代理服务也许可以帮到你。 - 自己部署，自己管理。 -- 简约词典插件: [https://github.com/fishjar/kiss-dictionary](https://github.com/fishjar/kiss-dictionary) - - 搭配本项目一起使用的划词翻译插件。 - - 支持英文单词、句子、汉字的查询。 - - 支持历史记录、单词收藏。 + +## 常见问题 + +### 为什么有些网页翻译不全 + +> 本插件的网页翻译是基于CSS选择器的，通用规则不能适配所有网页，有时需要自行添加相应网站的单独规则。如果不会写规则，可以到这里求助： https://github.com/fishjar/kiss-rules/issues + +### 规则设置的优先级是如何的 + +> 个人规则>覆写订阅规则>订阅规则>订阅规则>全局规则 +> 其中全局规则优先级最低，但非常重要，相当于默认规则。 + +### 为什么油管字幕一句话会断开翻译 + +> 本插件没有针对视频做特殊开发，对油管的支持也是当做网页翻译看待，自动生成字幕是流式生成并输出的，所以支持较差。 +> 如果需要关闭本插件的字幕翻译，增加一条规则即可，参考：https://github.com/fishjar/kiss-translator/issues/62 + +### 本地的Ollama接口不能使用 + +> 如果出现403的情况，参考：https://github.com/fishjar/kiss-translator/issues/174 + +### 填写的接口在油猴脚本不能使用 + +> 油猴脚本需要增加域名白名单，否则不能发出请求。 ## 开发指引