TLDRx

英语 | 简体中文

功能

• 支持私有 TLDR 页面仓库。
• 支持编辑私有 TLDR 页面。
• 显示带有平台信息的页面。
• 遵循 tldr-pages 客户端规范。[^1]
• 离线缓存官方 TLDR 页面仓库。
• 可配置官方 TLDR 页面存档下载链接。
• 尊重 HTTP_PROXY 和 HTTPS_PROXY 系统代理（适用于监管区域）。
• 高级配置：颜色样式、平台、编辑器...
• 支持 新的 TLDR 页面语法。[^2]

用法

显示 git commit 的页面

tldrx git commit

更新本地缓存（在显示官方页面之前需要执行一次）

tldrx --update

编辑或创建 git commit 的私有页面

tldrx -e git commit

更多信息

tldrx --help

安装

假设您已安装 rust cargo

cargo install tldrx

基准测试

在 GitHub Actions 机器上使用 Docker 容器进行基准测试（Dockerfile）使用 hyperfine 对每个客户端进行 100 圈测试。

注：研究表明，在 100ms 的时间范围内，人脑会将它视为即时反应^3。在此建议选择一个响应时间在 100ms 以内的客户端，并基于您需要的特性进行选择。如果您想获得更好的性能，请将 tldrx 构建为静态二进制文件，这将减少动态库的加载时间。

配置

配置文件 .tldrxrc 的位置因平台而异

• Linux ~/.tldrxrc
• MacOS ~/.tldrxrc
• Windows %USERPROFILE%\.tldrxrc

如果不存在，请创建一个。

模板 .tldrxrc

• [-] 选项为可选。
• <+> 选项为必选，只有当您需要该功能时。

# [-] Path to cache official tldr-pages
official_pages_dir = "/path/to/official/tldr-pages"

# <+> Path to private tldr-pages
private_pages_dir = "/path/to/private/tldr-pages"

# [-] Show pages for the given platform. Option: [osx | linux | ...]
platform = "linux"

# [-] Colorlize the output pages Choice: [auto | on | off]
sytled = "auto"

# [-] Editor to edit private tldr-pages
editor = "vi"

许可证

本项目采用 MIT 许可证和 MulanPSL-2.0 许可证双授权。您可以根据自己的需求自由选择。

[^1]: 使用 tldrx 代替 tldr。

[^2]: tldr-pages 的新语法是一个实验性的 RFC。