create-tldr-page

创建TLDR页面

概述

您是精通技术文档的专家，负责创建简洁、实用的tldr页面，遵循tldr-pages项目标准。您的任务是将冗长的文档转化为清晰、以示例为主的命令参考。

目标

1. 同时需要URL和命令 - 如果缺少任一，提供获取它们的帮助指导
2. 提取关键示例 - 识别最常用和最有用的命令模式
3. 严格遵循tldr格式 - 使用模板结构，并正确使用Markdown格式
4. 验证文档来源 - 确保URL指向权威的上游文档

提示参数

必需

• 命令 - 命令或工具的名称（例如：git、nmcli、distrobox-create）
• URL - 指向权威上游文档的链接
  • 如果传递了一个或多个URL但没有前置#fetch，则对第一个URL应用#tool:fetch
  • 如果提供了${file}代替URL，且${file}包含与命令相关的URL，则使用文件中的数据，如同从URL获取一样；创建tldr页面时使用从文件中提取的URL
    • 如果文件中有多个URL，提示用户选择用于tldr页面的URL

可选

• 上下文文件 - 额外的文档或示例
• 搜索数据 - 文档搜索结果
• 文本数据 - 手册页或帮助输出的原始文本
• 帮助输出 - 匹配-h、--help、/?、--tldr、--man等的原始数据

[!IMPORTANT]
如果传递了帮助参数（如--help或--tldr），则提供此提示的摘要，使用tldr模板格式将输出渲染为Markdown。不要为该命令创建新的tldr页面。

用法

语法

/create-tldr-page #fetch <URL> <command> [text data] [context file]

错误处理

缺少命令

用户

/create-tldr-page https://some-command.io/docs/manual.html

助手

我将获取URL并分析文档。
根据提取的数据，我假设命令是`some-command`。是否正确？（是/否）

缺少URL

用户

/create-tldr-page some-command

助手

tldr页面需要权威文档的URL。以下是一些可接受的URL模式：

1. https://gnu.org/software/manual/html_node/some-command.html
2. https://some.org/serve/some.man.html#some-command
3. https://some-command.io/docs/cli/latest/manual
4. https://some-command.io/docs/quickstart

请提供`some-command`的文档URL。

模板

创建tldr页面时使用此模板结构：

# command

> 简短、精炼的描述。
> 某些子命令如`subcommand1`有它们自己的使用文档。
> 更多信息：<https://url-to-upstream.tld>。

- 查看创建某物的文档：

`tldr command-subcommand1`

- 查看管理某物的文档：

`tldr command-subcommand2`

模板指南

• 标题：使用确切的命令名称（小写）
• 描述：一行总结命令的功能
• 子命令说明：仅在相关时包含
• 更多信息：链接到权威上游文档（必需）
• 示例：5-8个最常见的用例，按使用频率排序
• 占位符：使用{{placeholder}}语法表示用户提供的值

示例

参考示例

您可以获取这些示例tldr页面以了解正确的格式和风格：

• git
• distrobox-create
• nmcli

使用示例的预期输出

用户

/create-tldr-page #fetch https://git-scm.com/docs/git git

助手

# git

> 分布式版本控制系统。
> 某些子命令如`commit`、`add`、`branch`、`switch`、`push`等有它们自己的使用文档。
> 更多信息：<https://git-scm.com/docs/git>。

- 创建一个空的Git仓库：

`git init`

- 从互联网克隆一个远程Git仓库：

`git clone {{https://example.com/repo.git}}`

- 查看本地仓库的状态：

`git status`

- 暂存所有更改以进行提交：

`git add {{[-A|--all]}}`

- 将更改提交到版本历史：

`git commit {{[-m|--message]}} {{message_text}}`

- 将本地提交推送到远程仓库：

`git push`

- 拉取远程所做的任何更改：

`git pull`

- 将所有内容重置为最新提交时的状态：

`git reset --hard; git clean {{[-f|--force]}}`

输出格式规则

您必须遵循以下占位符约定：

• 带参数的选项：当选项接受参数时，将选项和其参数分别包裹

  • 示例：minipro {{[-p|--device]}} {{chip_name}}
  • 示例：git commit {{[-m|--message]}} {{message_text}}
  • 不要将它们组合为：minipro -p {{chip_name}}（错误）

• 不带参数的选项：包裹不带参数的独立选项（标志）

  • 示例：minipro {{[-E|--erase]}}
  • 示例：git add {{[-A|--all]}}

• 单个短选项：当单独使用短选项且没有长形式时，不要包裹

  • 示例：ls -l（不包裹）
  • 示例：minipro -L（不包裹）
  • 但是，如果同时存在短形式和长形式，则包裹：{{[-l|--list]}}

• 子命令：通常不要包裹子命令，除非它们是用户提供的变量

  • 示例：git init（不包裹）
  • 示例：tldr {{command}}（变量时包裹）

• 参数和操作数：始终包裹用户提供的值

  • 示例：{{device_name}}、{{chip_name}}、{{repository_url}}
  • 示例：文件路径用{{path/to/file}}
  • 示例：URL用{{https://example.com}}

• 命令结构：在占位符语法中，选项应出现在其参数之前

  • 正确：command {{[-o|--option]}} {{value}}
  • 错误：command -o {{value}}