Markdown and MDX translation CLI with token estimation
Project description
mdtomd
用于 Markdown / MDX 文档翻译的命令行工具,支持翻译前 token 估算、批量处理和结构化 JSON 输出。
默认会读取当前目录的 config.yaml,支持:
- 单文件翻译
- 目录批量翻译
.md/.markdown/.mdx- 翻译前 token 估算
- 翻译后显示输入 / 输出 token
安装
发布版安装:
python3 -m pip install mdtomd
本地开发安装:
python3 -m pip install -e .
如果想尽量自动把 mdtomd 放进当前机器的可执行路径:
./scripts/install_cli.sh
Windows:
powershell -ExecutionPolicy Bypass -File .\scripts\install_cli.ps1
配置
直接改 config.yaml 即可。
常见方式:
- 在
providers.<provider>里写model/base_url/api_key/max_tokens - 在
llm.provider里选默认 provider translator.chunk_size留空时,会默认跟当前模型的max_tokens一致- 临时覆盖时再用命令行参数或环境变量
如果不想把 key 写进配置,可以用环境变量,例如:
export DEEPSEEK_API_KEY="your-key"
用法
快捷命令,先 estimate 再 translate:
mdtomd examples/doc1.md
mdtomd examples
单文件翻译:
mdtomd translate -i examples/doc1.md
目录翻译:
mdtomd translate -i examples
目录输入会自动递归处理,并默认把结果写回原目录,生成 *_zh.md / *_zh.mdx。
如果想输出到别的目录:
mdtomd translate -i examples --output-dir out
先看 token:
mdtomd estimate -i examples/doc1.md
mdtomd estimate -i examples
给插件或脚本用结构化输出:
mdtomd estimate -i examples/doc1.md --json
mdtomd translate -i examples/doc1.md --json
查看 provider 和模型:
mdtomd providers
mdtomd models
输出说明
单文件翻译完成后会额外打印:
原文 tokens请求输入 tokens回复输出 tokens
其中:
请求输入 tokens是按当前 prompt 和分块策略统计的输入 token回复输出 tokens是模型接口实际返回的 completion token
测试
python3 -m unittest discover -s tests -v
CLI 发布
构建并检查产物:
./scripts/build_cli.sh
上传到 PyPI:
export TWINE_PASSWORD="pypi-***"
./scripts/publish_cli.sh
VS Code 插件
插件目录在 vscode-extension/。
当前插件已支持:
- 文件树右键翻译 Markdown 文件
- 文件树右键翻译文件夹
- 首次安装后自动检测 CLI,缺失时会从 PyPI 自动安装
mdtomd - 启动时可自动检查并升级 CLI,但已固定
mdtomd.cliPath时不会自动升级 - 先调用
estimate --json弹确认框 - 从
config.yaml已配模型里选择 - 直接在 VS Code 设置面板里按“通用 + 厂商分组”填写模型参数,不需要手改
settings.json - 支持 DeepSeek、MiniMax、OpenAI、OpenAI Codex、OpenRouter、Anthropic、Gemini、Z.ai、Kimi、Alibaba、OpenAI Compatible
- 状态栏显示完成结果
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mdtomd-0.2.0.tar.gz.
File metadata
- Download URL: mdtomd-0.2.0.tar.gz
- Upload date:
- Size: 36.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3d802e8e5ef11defd8411f011a5955d3a3020532dc958a9bd84fca0cacf7a123
|
|
| MD5 |
4cb2e923b74a2c32f5ed2d61a78dd85f
|
|
| BLAKE2b-256 |
9cd3c663e8906450505e9b27998a7919ba8689764f4cdedec972735f8613665f
|
File details
Details for the file mdtomd-0.2.0-py3-none-any.whl.
File metadata
- Download URL: mdtomd-0.2.0-py3-none-any.whl
- Upload date:
- Size: 38.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bfbb7599ae21af7c2646e9fd06addbebd220d7a74974fa0f7680f59abbc772f9
|
|
| MD5 |
d27d2abc76ce940f3b10cfba76a43084
|
|
| BLAKE2b-256 |
ca9c698a00831fe020997fff6115fa0f88047387b6143ac7088ac28cf25fa7de
|