Files
Luong NGUYEN 89e89d4aa3 feat(zh): add Chinese translations in zh/ directory
Add Chinese (Simplified) translations for all documentation, organized
under a dedicated zh/ directory that mirrors the English folder structure.

Co-authored-by: tanqingkuang <tanqingkuang@users.noreply.github.com>

Translations originally contributed by @tanqingkuang in #45.
Restructured from *-CN.md suffix pattern into zh/ directory to prevent
the EPUB builder (scripts/build_epub.py collect_folder_files) from
picking up Chinese files via glob("*.md") inside module folders.
2026-04-06 23:08:54 +02:00
..

EPUB 构建脚本

功能

这个脚本会把整份指南构建成 EPUB 电子书,方便离线阅读。

需求

  • Python 环境
  • uv
  • 相关依赖

快速开始

最简单的方式是直接让 uv 帮你处理依赖:

uv run scripts/build_epub.py

开发环境

如果你要修改脚本本身,可以先创建虚拟环境,再安装开发依赖。

# 创建虚拟环境

# 激活并安装依赖

# 运行测试

# 运行脚本

命令行选项

常见选项包括:

  • 指定输出路径
  • 打开详细日志
  • 限制并发请求

示例

# 带详细输出构建

# 指定输出位置

# 限制并发数(遇到限流时)

输出

脚本会生成 EPUB 文件,里面包含所有内容和渲染后的图表。

运行测试

你可以用虚拟环境或直接通过 uv 运行测试。

依赖

脚本依赖的包会在项目的开发依赖里列出。

故障排查

  • 检查 uv 是否可用
  • 检查 Python 版本
  • 检查依赖是否安装完整