Skip to content

Commit 67b87d6

Browse files
authored
docs: add demo URL and preview & update head (#128)
1 parent 94040ec commit 67b87d6

6 files changed

Lines changed: 25 additions & 32 deletions

File tree

README.md

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,26 +12,17 @@
1212
</div>
1313

1414

15-
Translate EPUB books using Large Language Models while preserving the original text. The translated content is displayed side-by-side with the original, creating bilingual books perfect for language learning and cross-reference reading.
15+
Want to read a book in a foreign language without losing the original context? EPUB Translator transforms any EPUB into a bilingual edition with AI-powered translations displayed side-by-side with the original text.
1616

17-
![Translation Effect](./docs/images/translation.png)
17+
Whether you're learning a new language, conducting academic research, or simply enjoying foreign literature, you get both versions in one book - preserving all formatting, images, and structure.
1818

19-
## Features
19+
![Translation Effect](./docs/images/translation.png)
2020

21-
- **Bilingual Output**: Preserves original text alongside translations for easy comparison
22-
- **LLM-Powered**: Leverages large language models for high-quality, context-aware translations
23-
- **Format Preservation**: Maintains EPUB structure, styles, images, and formatting
24-
- **Complete Translation**: Translates chapter content, table of contents, and metadata
25-
- **Progress Tracking**: Monitor translation progress with built-in callbacks
26-
- **Flexible LLM Support**: Works with any OpenAI-compatible API endpoint
27-
- **Caching**: Built-in caching for progress recovery when translation fails
21+
### Online Demo
2822

29-
## Use Cases
23+
We provide an [online demo platform](https://hub.oomol.com/package/books-translator) where you can try EPUB Translator's bilingual translation capabilities without any installation. Simply upload your EPUB file and get a translated bilingual edition.
3024

31-
- **Language Learning**: Read books in their original language with side-by-side translations
32-
- **Academic Research**: Access foreign literature with bilingual references
33-
- **Content Localization**: Prepare books for international audiences
34-
- **Cross-Cultural Reading**: Enjoy literature while understanding cultural nuances
25+
[![EPUB Translator Online Demo](docs/images/online-en.png)](https://hub.oomol.com/package/books-translator)
3526

3627
## Installation
3728

README_zh-CN.md

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,31 +7,22 @@
77
<a href="https://pypi.org/project/epub-translator/" target="_blank"><img src="https://img.shields.io/pypi/pyversions/epub-translator.svg" alt="python versions" /></a>
88
<a href="https://github.com/oomol-lab/epub-translator/blob/main/LICENSE" target="_blank"><img src="https://img.shields.io/github/license/oomol-lab/epub-translator" alt="license" /></a>
99
</p>
10-
<p><a href="https://hub.oomol.com/package/books-translator?open=true" target="_blank"><img src="https://static.oomol.com/assets/button.svg" alt="Open in OOMOL Studio" /></a></p>
10+
<p><a href="https://hub.oomol.com/zh-CN/package/books-translator?open=true" target="_blank"><img src="https://static.oomol.com/assets/button.svg" alt="Open in OOMOL Studio" /></a></p>
1111
<p><a href="./README.md">English</a> | 中文</p>
1212
</div>
1313

1414

15-
使用大语言模型翻译 EPUB 电子书,同时保留原文。译文与原文并列显示,打造完美的双语阅读体验,特别适合语言学习和对照阅读
15+
想读一本外文书,却担心失去原文的语境?EPUB Translator 可以将任何 EPUB 转换成双语版本,AI 翻译与原文并列展示
1616

17-
![翻译效果](./docs/images/translation.png)
17+
无论你是在学习新语言、进行学术研究,还是纯粹享受外国文学,你都能在一本书中同时获得两种版本——保留所有格式、图片和结构。
1818

19-
## 特性
19+
![翻译效果](./docs/images/translation.png)
2020

21-
- **双语对照**: 保留原文并与译文并列显示,方便对照阅读
22-
- **AI 驱动**: 利用大语言模型提供高质量、上下文感知的翻译
23-
- **格式保留**: 完整保持 EPUB 结构、样式、图片和格式
24-
- **全面翻译**: 翻译章节内容、目录和元数据
25-
- **进度追踪**: 内置回调函数监控翻译进度
26-
- **灵活的 LLM 支持**: 兼容任何 OpenAI 风格的 API 端点
27-
- **缓存机制**: 内置缓存功能用于翻译失败后恢复进度
21+
### 在线体验
2822

29-
## 使用场景
23+
我们提供[在线演示平台](https://hub.oomol.com/zh-CN/package/books-translator),无需安装即可体验 EPUB Translator 的双语翻译功能。只需上传您的 EPUB 文件,即可获得翻译后的双语版本。
3024

31-
- **语言学习**: 阅读原版书籍的同时参考译文
32-
- **学术研究**: 访问外文文献并获得双语参考
33-
- **内容本地化**: 为国际读者准备书籍
34-
- **跨文化阅读**: 在理解文化细微差别的同时欣赏文学作品
25+
[![EPUB Translator 在线演示](docs/images/online-cn.png)](https://hub.oomol.com/zh-CN/package/books-translator)
3526

3627
## 安装
3728

docs/changelog/v0.1.9.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Release v0.1.9
2+
3+
This release fixes an issue with namespace handling in EPUB metadata files.
4+
5+
## 🐛 Bug Fixes
6+
7+
### Fixed Namespace Structure Preservation in TOC and OPF Files (#127)
8+
9+
Fixed an issue where the XML namespace structure in Table of Contents (TOC) and OPF metadata files was not properly preserved during translation, which could cause compatibility issues with some e-readers.
10+
11+
Related PR: https://github.com/oomol-lab/epub-translator/pull/127

docs/images/online-cn.png

174 KB
Loading

docs/images/online-en.png

173 KB
Loading

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "epub-translator"
3-
version = "0.1.8"
3+
version = "0.1.9"
44
description = "Translate the epub book using LLM. The translated book will retain the original text and list the translated text side by side with the original text."
55
keywords = ["epub", "llm", "translation", "translator"]
66
authors = [

0 commit comments

Comments
 (0)