skills.rest
hadenlabs
hadenlabsOFFICIAL
Explore all skills by this author →
Website𝕏@hadenlabsGitHub

skills-readme-generator

Generate readme.yaml metadata from SKILL.md files for all skills.

1|Updated Dec 9, 2024
Search Tags:#template#documentation#ai#readme#yaml#generate#skill-metadata
One-click install
npx skills add https://github.com/hadenlabs/tasks --skill skills-readme-generator
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: skills-readme-generator
Source: https://github.com/hadenlabs/tasks/tree/main/.claude/skills/skills-readme-generator
Command: npx skills add https://github.com/hadenlabs/tasks --skill skills-readme-generator

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Manual generation of machine-readable skill metadata is error-prone and time-consuming; this tool automates extracting metadata from SKILL.md and populates readme.yaml templates for consistency across skills.

Core Features & Use Cases

  • Extracts metadata from SKILL.md using AI to produce structured fields.
  • Locates readme.yaml.tpl in the skill base directory and fills it with extracted data.
  • Creates readme.yaml in each skill directory only when missing, preserving the original SKILL.md.
  • Supports auditing and reporting of generated vs existing files for maintainers.

Quick Start

Run the skills-readme-generator to scan all skills and generate readme.yaml files where missing.

Frequently Asked Questions about skills-readme-generator

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

FAQPage Schema
How do I automatically generate readme.yaml metadata from markdown files?▼

To automatically generate readme.yaml metadata from markdown files, use this Skill to scan all SKILL.md files, extract structured fields using AI, and populate a standard readme.yaml template. It ensures the readme.yaml file is created only when missing.

What is the best way to extract skill metadata into a YAML template?▼

The best way to extract skill metadata into a YAML template is to locate the readme.yaml.tpl file in your base directory and let the AI populate it with structured fields extracted from your SKILL.md, ensuring consistent documentation across all skills.

Can I generate readme.yaml files for multiple skills without overwriting existing ones?▼

Yes, you can generate readme.yaml files for multiple skills without overwriting existing ones. The tool audits skill directories and creates the readme.yaml file only if it is missing, preserving your original SKILL.md files.

Does the readme.yaml generator modify my original SKILL.md documentation?▼

No, the readme.yaml generator does not modify your original SKILL.md documentation. It extracts metadata from the file to populate a YAML template and preserves the original markdown content entirely.

How does AI extract structured metadata for readme.yaml from SKILL.md?▼

AI extracts structured metadata for readme.yaml by parsing the SKILL.md content, identifying key descriptive fields, and mapping them directly into a standard readme.yaml template to automate machine-readable documentation.

Related Skills

Explore More Content & Communication Skills→
matt-fell-aimatt-fell-ai
1

actuate

Trigger IoT devices, HomeAssistant, and webhooks for physical actions.

Community
Intermediate
popiliadampopiliadam
25

glossary-audit

Audit glossary files for missing and orphaned terms.

Community
Advanced
ddttomddttom

md-workflow

Create, edit, and lint Markdown files with YAML frontmatter awareness.

Community
Intermediate
fro-botfro-bot

compound-docs

Document solved problems as categorized Markdown files with YAML frontmatter.

Community
Advanced