@tank/github-docs

Official

Write excellent GitHub docs.

Authortankpkg
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill helps you write excellent GitHub documentation for libraries and developer tools, ensuring clarity and scannability for your audience.

Core Features & Use Cases

  • README Anatomy: Covers essential sections like hero, features, quick start, and API reference.
  • GitHub Markdown Features: Utilizes alerts, mermaid diagrams, badges, collapsible sections, and more.
  • Use Case: You need to write a compelling README for your new open-source library that clearly explains its features, installation, and usage, making it easy for other developers to adopt.

Quick Start

Use the github-docs skill to generate a README for a new Node.js library.

Dependency Matrix

Required Modules

None required

Components

scriptsreferences

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: @tank/github-docs
Download link: https://github.com/tankpkg/skills/archive/main.zip#tank-github-docs

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.