skills.rest
ultraviollettnympho
ultraviollettnymphoCOMMUNITY
Explore all skills by this author →
GitHub

create-tldr-page

Creates tldr pages from documentation URLs and command examples following tldr-pages standards.

1|1|Updated Jan 29, 2026
Search Tags:#template#documentation#markdown#technical writing#cli#command reference#tldr
One-click install
npx skills add https://github.com/ultraviollettnympho/transit-ticket --skill create-tldr-page-ultraviollettnympho
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: create-tldr-page
Source: https://github.com/ultraviollettnympho/transit-ticket/tree/main/.github/skills/create-tldr-page
Command: npx skills add https://github.com/ultraviollettnympho/transit-ticket --skill create-tldr-page-ultraviollettnympho

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing concise, example-driven command documentation in the tldr-pages format is tedious and error-prone, requiring strict adherence to placeholder syntax, template structure, and style conventions. ## Core Features & Use Cases - Documentation Fetching: Retrieves authoritative upstream documentation from a provided URL and extracts the most common command usage patterns. - Strict Template Compliance: Generates pages following the official tldr-pages markdown template with proper title, description, and 5-8 ordered examples. - Placeholder Conventions: Enforces correct {{placeholder}} syntax for options, arguments, subcommands, and user-provided values. - Use Case: A maintainer wants to contribute a tldr page for nmcli; they provide the command name and the official documentation URL, and receive a properly formatted page ready for submission. ## Quick Start Ask the assistant to create a tldr page for the git command using the documentation at https://git-scm.com/docs/git.

Frequently Asked Questions about create-tldr-page

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a tldr page for a command?▼

Provide the command name and a URL to its authoritative upstream documentation. The skill fetches the documentation, extracts the most common usage patterns, and outputs a markdown page following the official tldr-pages template with 5-8 examples.

What is the correct placeholder syntax for tldr pages?▼

Wrap user-provided values in double curly braces like {{file_name}}. Options with arguments wrap both parts separately, such as {{[-m|--message]}} {{text}}, while standalone short options like ls -l remain unwrapped.

What happens if I only provide a command name without a URL?▼

The skill requires both a command and a documentation URL. If the URL is missing, it responds with acceptable documentation URL patterns and asks you to supply the authoritative upstream link before generating the page.

Can I use a local file instead of a documentation URL?▼

Yes, if the provided file contains a relevant URL for the command, its content is used as if fetched from that URL. If the file contains multiple URLs, you will be prompted to choose which one to use.

What are the limitations of generated tldr pages?▼

Pages are limited to 5-8 of the most common examples ordered by frequency of use, so rare or advanced flags may be omitted. The output depends on the quality and completeness of the upstream documentation provided.

Related Skills

Explore More Software Engineering Skills→
JylhisJylhis
1

offline-docs

Locate and retrieve offline Unix documentation across Linux, macOS, and FreeBSD.

Community
Intermediate
dhar174dhar174
1

tldr-prompt

Generate tldr summaries for GitHub Copilot customization files and documentation URLs.

Community
Intermediate
githubgithub
38.5k

tldr-prompt

Generate tldr-style summaries for GitHub Copilot prompts, agents, instructions, and documentation.

Official
Intermediate
tamago0224tamago0224

create-tldr-page

Generate TLDR-formatted markdown pages from command-line tool documentation.

Community
Intermediate