文档教程知识库【免费下载链接】tldrCollaborative cheatsheets for console commands .项目地址https://gitcode.com/GitHub_Trending/tl/tldr点击查看免费下载本指南围绕仓库中的保加利亚语别名页 pages.bg/windows/clist.md 展开系统讲解 tldr 项目如何为「一个命令是另一个命令的别名」这一场景建立轻量文档别名页的三要素结构、多语言模板体系、以及背后由 scripts/set-alias-page.py 支撑的生成与同步工具链。读完本文你将掌握别名页的标准写法、原命令choco list的完整速查内容并理解 tldr 仓库中「别名页 → 原命令页」的文档组织与维护方式。别名页是什么为什么需要它tldr 是一个协作式维护的控制台命令速查手册仓库按平台common、linux、windows等与语言pages、pages.zh、pages.bg等组织成上万个 Markdown 速查页。其中有一类非常特殊的页面叫别名页Alias Page当一个命令只是另一个命令的别名时如果为它单独编写一份完整的速查文档不仅会造成内容重复还会出现「两个页面说法不一致、需要同步修改」的维护负担。tldr 的解决方案是为这类命令单独建一个页面但页内不重复罗列用法只保留三件事——命令名标题、它是什么命令的别名、以及如何查看原命令的完整文档。以clist为例它在仓库中被明确记录为 Chocolatey 包管理器choco list命令的别名见 pages/windows/clist.md因此用户直接运行clist与运行choco list的效果等价文档也只需一行指引即可完成导航。别名页的文档结构逐行解析clist保加利亚语别名页 pages.bg/windows/clist.md 全文只有 7 行但这 7 行恰好构成了别名页的完整骨架# clist Тази команда е псевдоним на choco list. - Виж документацията за оригиналната команда: tldr choco list逐行拆解其含义行内容作用第 1 行# clist一级标题即命令名本身是页面在客户端中显示与检索的键第 3 行 Тази команда е псевдоним наchoco list.描述行以引用块呈现声明「此命令是choco list的别名」第 5 行- Виж документацията за оригиналната команда:操作说明告诉读者「查看原命令的文档」第 7 行tldr choco list具体的执行命令用 tldr 客户端直接调取原命令choco list的速查页可以看出别名页刻意将「内容」让位给「导航」它本身不讲解任何参数用法唯一的可执行动作就是运行tldr choco list去读取真正的命令文档。这正是 alias 页与普通命令页在定位上的本质区别——普通命令页追求「开箱即读」别名页追求「一键跳转」。对应的英文原文位于 pages/windows/clist.md内容为# clist This command is an alias of choco list. - View documentation for the original command: tldr choco list中文版本位于 pages.zh/windows/clist.md「此命令为choco list的别名。查看原命令的文档tldr choco list」。别名页模板的国际化体系别名页之所以能在几十种语言中保持结构高度一致是因为仓库维护了一份别名页翻译模板contributing-guides/translation-templates/alias-pages.md。该文件按语言en、ar、bg、bn、zh、zh_TW等 40 余种收录了统一的别名页模板所有语言的别名页都必须严格照此结构编写。以保加利亚语模板为例其原文为# example Тази команда е псевдоним на example. - Виж документацията за оригиналната команда: tldr example模板中的example是占位符分别代表三种语义标题中的example第 1 次出现→ 命令名描述行中的example第 2 次出现→ 原命令名命令行中的example第 3 次出现→ 用于tldr调用的文档命令。将占位符依次替换为clist与choco list就得到上面看到的 pages.bg/windows/clist.md。这套模板体系的实际覆盖面可以从仓库文件系统中得到印证clist.md在pages*目录族下共存在40 个语言版本包括pages/windows/clist.md、pages.zh/windows/clist.md、pages.zh_TW/windows/clist.md、pages.ko/windows/clist.md、pages.ru/windows/clist.md等。任一语言的描述行都遵循同一种「X 命令是 Y 命令的别名」句式只是本地化措辞不同例如俄语模板为「Эта команда — псевдоним дляexample」韩语为「이 명령은example의 별칭입니다」繁体中文为「此命令為example的別名」。原命令速查choco list的完整用法别名页指向的原命令文档是 pages/windows/choco-list.md。当读者运行tldr choco list时得到的就是这张速查页。它的核心内容是列出 Chocolatey 本地已安装的软件包共覆盖 6 个典型场景场景命令说明列出本地已安装的包choco list最基础用法无任何附加参数包含系统程序一并列出choco list {{[-i\|--include-programs]}}除 Chocolatey 管理的包外还显示普通 Windows 系统程序只输出包 IDchoco list --id-only精简输出便于脚本化处理按名称精确匹配choco list {{package}} {{[-e\|--exact]}}只列出与给定名称完全一致的包需配合-e/--exact按前缀过滤choco list --id-starts-with {{prefix}}列出 ID 以指定前缀开头的包指定备选数据源choco list {{[-s\|--source]}} {{windowsfeatures\|ruby\|cygwin\|...}}从windowsfeatures、ruby、cygwin等特殊源中查询几个值得注意的参数细节-i/--include-programs默认choco list只统计 Chocolatey 自己安装的包加上该开关后会把系统中的原生程序也纳入列表适合做全量软件盘点。-e/--exact不加该开关时choco list package按「包含子串」的方式匹配只有配合--exact才做精确匹配避免误列出名称相近的其他包。--id-starts-with按前缀过滤是一种比--exact更宽松、又比全量列表更聚焦的折中方案常用于按厂商或项目前缀批量检索。-s/--source默认查询的是 Chocolatey 的官方源但可通过该参数切换到其他数据源示例中的windowsfeatures、ruby、cygwin是仓库文档明确给出的候选值。注意 tldr 文档中的占位符写法{{[-i|--include-programs]}}表示参数可写短形式也可写长形式{{package}}、{{prefix}}表示需要用户自行替换的输入值。这是 tldr 速查页统一的语法约定既保留了命令的真实可运行性又清晰地标出了需要读者填写的部分。别名页的生成与同步工具链别名页虽然内容简短但在多语言仓库中维护数十个版本并不轻松。仓库为此提供了专门的工具脚本 scripts/set-alias-page.py它承担两类职责交互式创建/更新通过-p platform/alias_command指定别名页路径脚本会以向导形式依次询问页面标题、原命令、文档命令校验后生成页面批量同步通过--sync-S读取英文别名页将每个别名页同步到所有语言目录中已有的对应翻译页。从源码看其核心机制非常清晰占位符替换函数generate_alias_page_contentscripts/set-alias-page.py从 contributing-guides/translation-templates/alias-pages.md 读入对应语言的模板然后按顺序把example依次替换为页面标题、原命令名和文档命令名。别名页识别函数get_alias_command_in_pagescripts/set-alias-page.py通过正则解析页面的描述行与tldr ...命令行提取出original_command与documentation_command从而判断某个页面是否为别名页。模板匹配校验get_locale_alias_patternscripts/set-alias-page.py从各语言模板中提取「X 命令是 Y 命令的别名」句式的本地化表达用于在同步时精确匹配非标准写法。脚本的典型用法摘自其 docstring# 交互式创建一个新别名页如 macOS 下的 gsum python3 scripts/set-alias-page.py -p osx/gsum # 将英文别名页同步到所有翻译 python3 scripts/set-alias-page.py --sync # 只同步巴西葡萄牙语 python3 scripts/set-alias-page.py --sync --language pt_BR # 同步并暂存修改需要 git python3 scripts/set-alias-page.py --sync --stage # 预演仅查看将要发生的改动 python3 scripts/set-alias-page.py --sync --dry-run值得说明的是脚本 docstring 明确提醒--sync会产生较多误报官方并不建议在生产中直接全量同步若使用应只暂存改动、并按语言逐一核对提交。--dry-run与--stage正是为这种「先看后改」的谨慎流程设计的。从别名页到原命令页tldr 的文档导航闭环至此clist这条命令在 tldr 中的完整文档链路已经清晰pages.bg/windows/clist.md别名页声明 clist choco list 的别名 │ 运行 tldr choco list ▼ pages/windows/choco-list.md原命令页列出本地已安装包的 6 种用法使用者无论身处哪一语言环境只要键入tldr clist客户端就会展示别名页并引导执行tldr choco list进而获得完整、可复制的命令速查内容。而对仓库维护者而言新增一个别名只需按模板写 4 行有效内容或者直接用set-alias-page.py的交互向导生成原命令的参数调整也只需改动唯一的原命令页别名页永远不需要跟着改——这正是别名页机制在信息密度与可维护性之间取得平衡的关键设计。小结别名页是 tldr 对「命令互为别名」场景的轻量文档方案只含标题、别名声明、跳转命令三个要素pages.bg/windows/clist.md 是其保加利亚语实例结构由翻译模板统一约束contributing-guides/translation-templates/alias-pages.md 定义了 40 余种语言的别名页模板仓库中clist.md共有 40 个语言版本原命令文档承担全部实战内容pages/windows/choco-list.md 覆盖choco list的默认列出、-i/--include-programs、--id-only、-e/--exact、--id-starts-with、-s/--source等 6 个用法工具链支撑规模化维护scripts/set-alias-page.py 通过模板占位符替换实现别名页的创建、识别与多语言同步。赞分享文档教程知识库【免费下载链接】tldrCollaborative cheatsheets for console commands .项目地址https://gitcode.com/GitHub_Trending/tl/tldr点击查看免费下载相关推荐tldr 别名页Alias Page机制深度解析以 luantiserver 别名页为例tldr 别名页Alias Page机制深度解析以 luantiserver 别名页为例 本文以 tldr 仓库中的 pages.bg/common/lu文档教程知识库tldr 别名页面Alias Pages机制解析以阿拉伯语版 vc → vercel 页面为例tldr 别名页面Alias Pages机制解析以阿拉伯语版 vc → vercel 页面为例 pages.ar/common/vc.md 是一份典型的文档教程知识库tldr 别名页面Alias Page机制详解以 pamnoraw 为例tldr 别名页面Alias Page机制详解以 pamnoraw 为例 导读 pamnoraw 是 tldr 仓库 https://link.gitco文档教程知识库上一篇3步完成乐谱数字化Audiveris开源OMR工具终极指南下一篇文档下载神器kill-doc告别繁琐操作一键获取30平台免费资源创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考