Does it handle GitHub profile READMEs?

No, special-purpose repositories like personal profile READMEs (username/username) are intentionally excluded to avoid overriding personal landing page designs.

Does it support package managers other than pnpm?

Yes. While the skill prioritizes pnpm as the primary example, it automatically includes alternative installation commands for npm and yarn to ensure broad compatibility.

Does it generate badges or decorative graphics?

No, this skill follows a 'no-frills' philosophy, focusing on clean, practical, and text-based information that is easy to read and maintain for developers.

How does the skill determine my project type?

It analyzes your project's root files, specifically looking for 'bin', 'main', or 'exports' fields in package.json or the presence of a .claude-plugin/marketplace.json file.

Can I use it on an existing README file?

Absolutely. The skill is designed to update existing README files by detecting and adding missing sections while preserving your current formatting and content style.

Stylish README Generator

Name: Stylish README Generator
Author: StyleList94

byStyleList94

0•

Aprendizaje y Documentación

Generates clean, professional README documentation automatically tailored to your project's specific type and architecture.

The Stylish README skill streamlines the documentation process by intelligently detecting whether a project is a library, CLI tool, or plugin marketplace based on file markers like package.json fields. It enforces a consistent, high-quality structure that prioritizes pnpm usage and provides clear installation, usage, and API reference sections, ensuring that your documentation remains practical, no-frills, and easy to navigate for both users and contributors. It is particularly useful for developers who want to maintain high documentation standards without manual overhead.

Características Principales

01Language-specific code block formatting for better readability

02Automatic project type detection (Library, CLI, Plugin, or Personal)

03Standardized section structures tailored to project purpose

04Smart updates that preserve existing styles while adding missing content

05Integrated package manager instructions with pnpm-first logic

060 GitHub stars

Casos de Uso

01Bootstrapping a new open-source library with professional-grade documentation

02Enhancing CLI tool documentation with clear options and usage examples

03Standardizing README files across multiple repositories in an organization

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add stylelist94/claude-plugins readme

For use in Claude.ai and ChatGPT

Download Skill