Skip to content

README.md

Latest commit

 

History

History
102 lines (72 loc) · 2.95 KB

README.md

File metadata and controls

102 lines (72 loc) · 2.95 KB

github-showcase

A Claude Code skill that generates LinkedIn and Facebook posts from any GitHub project — saved as a styled Word document you can open, copy, and paste directly.

What It Does

Point it at any GitHub repo and it:

  1. Pulls your project data (README, metadata, languages, releases)
  2. Finds screenshots in your local project directory
  3. Generates detailed, emoji-rich posts for LinkedIn and Facebook
  4. Creates a styled .docx file in your project's social-media-posts/ folder
  5. Embeds your project screenshots directly in the document

Open the Word file, copy the content for your platform, paste, attach images, post. That's it.

Example Output

The generated Word document includes:

  • Quick Guide — how to use the document
  • LinkedIn Post — professional storytelling tone, with platform tips
  • Facebook Post — casual and conversational, link in body
  • Screenshots — your project images embedded and ready to attach
  • Visual Tips — what GIF to record, what to screenshot, social preview suggestions

Installation

Prerequisites

pip install python-docx

Install the Skill

User-level (available in all projects):

# Clone to your Claude skills directory
git clone https://github.com/Ublaze/github-showcase.git ~/.claude/skills/github-showcase

Project-level (available only in one project):

git clone https://github.com/Ublaze/github-showcase.git .claude/skills/github-showcase

Usage

In any Claude Code session:

/showcase Caffeinator
/showcase https://github.com/user/repo

The Word document will be saved to:

{your-project-dir}/social-media-posts/{ProjectName}_Showcase_{date}.docx

How It Works

  1. The skill instructs Claude to gather your GitHub repo data via gh api
  2. Claude finds screenshots in your local project's assets/, screenshots/, or docs/images/ folders
  3. Claude generates platform-specific content (LinkedIn + Facebook) with emojis, hooks, and CTAs
  4. The showcase_generator.py script creates a styled Word document with:
    • Boxed content sections (copy-paste ready)
    • Platform-specific tips
    • Embedded screenshots
    • Visual content recommendations

Content Style

Posts are generated with:

  • Problem-first hooks — never "I'm excited to announce..."
  • Generous emojis throughout
  • Detailed content (1200-2000 characters) — not a teaser, a full showcase
  • Feature bullet points with emojis
  • Technical highlights kept accessible
  • Personal reflection on what you learned
  • CTA + hashtags at the end

Requirements

Requirement Details
Claude Code Any recent version
GitHub CLI gh authenticated with your account
Python 3.11+
python-docx pip install python-docx

License

MIT