convez.ai
SkillAutomaçãoIntermediário
JUJING-DEEP

GitHub Publisher Skill

JUJING-DEEP/github-publisher

Gera READMEs profissionais para Skills em um comando

Ver no GitHub
InicialPluginScore · de 0 a 100

Skill que gera automaticamente READMEs profissionais para Skills do Claude, seguindo padrões de projetos open source de alta qualidade. Automatiza a coleta de informações, geração de documentação estruturada, validação de qualidade e publicação no GitHub com um único comando.

Instalação

$npx convez-ai JUJING-DEEP/github-publisher

1 comando no terminal: detecta o formato do repositório (marketplace ou plugin avulso) e instala via Claude Code. Requer Node 18+ e o Claude Code instalado.

Métricas

Estrelas
1
Forks
0
Acompanhando
0
Saúde
42%
Último commit
há 5 meses
Versão
—
Issues abertas
0
Contribuidores
1

Casos de uso

  • Publicar novos Skills no GitHub com documentação completa e padronizada
  • Atualizar automaticamente READMEs quando Skills são modificados
  • Manter documentação consistente entre múltiplos Skills em um portfólio

Veredito

Ferramenta bem-pensada para o workflow específico de criação e publicação de Skills, eliminando repetição na documentação. Útil para desenvolvedores que frequentemente criam novos Skills e precisam manter padrão de qualidade.

README

A tradução para o português deste README ainda está na fila.

GitHub Publisher Skill

自动为 Claude Skill 生成专业 GitHub 文档,一行命令完成发布。

License: MIT Agent Skills skills.sh Multi-Runtime

每次创建新 Skill 后,只需一行命令,自动产出符合开源社区标准的专业文档。

基于开放的 Agent Skills 协议,可在 Claude Code、Codex、Cursor、OpenClaw、Hermes Agent、CodeBuddy、Workbuddy、Gemini CLI、OpenCode 等 50+ 兼容 runtime 中运行。

功能演示 · 安装 · 使用方法 · 工作原理 · 项目结构

其他语言 / Other Languages / 他の言語 / 다른 언어 / Otros Idiomas:

English · 日本語 · 한국어 · Español

Star History Chart


功能演示

用户      ❯ /publish skills/my-new-skill

GitHub    ❯ 正在读取 my-new-skill...
Publisher ❯ ✅ 已读取 SKILL.md、scripts/、references/
          ❯ 📝 正在生成专业 README...
          ❯ ✅ README 生成完成
          ❯ 🔍 质量检查通过
          ❯ 📤 正在提交到 GitHub...

用户      ❯ yes

GitHub    ❯ 🎉 发布成功!
Publisher ❯ https://github.com/JUJING-DEEP/my-new-skill

自动生成的文档包含:

  • 项目标题 + 徽章行(Stars / License / Version)
  • 一句话精准介绍
  • 核心功能(3-5 项具体说明)
  • 快速开始(5 分钟内跑起来)
  • 详细使用说明
  • 配置项表格
  • 至少 3 个使用示例
  • 项目结构目录树
  • 贡献指南
  • MIT License

工作原理

你创建新 Skill
         ↓
/publish 命令触发
         ↓
┌──────────────────────────────────────┐
│       GitHub Publisher Skill          │
│  1. 读取 Skill 代码(SKILL.md 等)    │
│  2. 调用文档生成逻辑                  │
│  3. 润色成高星项目风格                │
│  4. 写入 README.md                   │
│  5. git add / commit / push          │
└──────────────────────────────────────┘
         ↓
GitHub 仓库(完整专业文档)

Phase 1:信息收集

  1. 确认目标 Skill 的路径
  2. 读取以下文件:
    • SKILL.md 或主逻辑文件
    • 所有 references/ 下的文档
    • 所有 scripts/ 下的代码
    • 已有的 README.md(如果存在)
  3. 提取关键信息:
    • 技能名称和核心功能
    • 输入/输出格式
    • 依赖项和兼容性
    • 使用场景和触发条件

Phase 2:生成 README

必须包含的章节(按顺序):

  1. 项目标题 + 徽章行
  2. 一句话介绍
  3. 功能演示 GIF 或截图占位
  4. 核心功能(3-5 个要点)
  5. 快速开始
  6. 详细使用说明
  7. 配置项(表格形式)
  8. 使用示例(至少 3 个)
  9. 项目结构
  10. 贡献指南
  11. License

Phase 3:质量检查

  • 所有代码块都有语言标注
  • 安装步骤可以一步步跟着做
  • 没有"TODO"或空白占位符
  • 配置表格的每一行都有默认值

Phase 4:Git 发布

cd <skill-path>
git add README.md
git commit -m "docs: auto-generate README"
git push origin main

安装

GitHub Publisher 基于开放的 Agent Skills 协议,可在任何 skills-compatible 的 AI agent runtime 中运行。

方式一:一行命令(推荐,跨 runtime)

打开你正在用的 agent(Claude Code、Codex、Cursor、OpenClaw、Hermes、CodeBuddy、Workbuddy、Gemini CLI、OpenCode 等),告诉它:

帮我安装这个 skill:https://github.com/JUJING-DEEP/github-publisher

或者用通用 CLI 安装器(vercel-labs/skills,支持 55+ runtime):

npx skills add JUJING-DEEP/github-publisher

它会自动识别你当前的 runtime 并把 skill 放到正确目录。需要指定时加 -a claude-code / -a codex / -a cursor / -a openclaw 等参数。

方式二:手动安装

Runtime安装路径
Claude Code~/.claude/skills/github-publisher/
Codex CLI~/.codex/skills/github-publisher/
Cursor~/.cursor/skills/github-publisher/
OpenClaw~/.openclaw/workspace/skills/github-publisher/
Hermes Agent跑 tools/install_hermes_skill.py
CodeBuddy~/.codebuddy/skills/github-publisher/
Workbuddy~/.workbuddy/skills/github-publisher/
Gemini CLI~/.gemini/skills/github-publisher/
OpenCode~/.opencode/skills/github-publisher/
其他 runtimeclone 到对应 runtime 的 skills/ 目录
git clone https://github.com/JUJING-DEEP/github-publisher <上面对应的路径>

方式三:作为参考资料使用

即使 runtime 不支持 Agent Skills 自动加载,你也可以直接把 SKILL.md 的内容粘贴进对话——它本质就是一份 markdown + YAML frontmatter。


使用方法

基本命令

/publish

指定路径

/publish skills/my-new-skill

在其他 Agent 中触发

帮我发布这个 Skill 到 GitHub:skills/my-data-analyzer

完整工作流

1. /publish [可选:Skill路径]
2. GitHub Publisher 自动读取 Skill 的所有文件
3. 生成专业 README 预览
4. 展示预览,询问是否满意
5. 确认后执行 git add / commit / push
6. 返回 GitHub 链接

支持的平台

平台状态安装命令
Claude Code✅ 完全支持/skill add JUJING-DEEP/github-publisher
Codex✅ 完全支持npx skills add JUJING-DEEP/github-publisher
Cursor✅ 完全支持npx skills add JUJING-DEEP/github-publisher
OpenClaw✅ 完全支持npx skills add JUJING-DEEP/github-publisher
Hermes Agent✅ 完全支持参考手动安装
CodeBuddy✅ 完全支持参考手动安装
Workbuddy✅ 完全支持参考手动安装
Gemini CLI✅ 完全支持参考手动安装
OpenCode✅ 完全支持参考手动安装
其他✅ 兼容参考 Agent Skills 协议

项目结构

github-publisher/
├── SKILL.md                         # 核心 Skill 逻辑
├── README.md                        # 本文档(中文)
├── README_EN.md                     # English 版本
├── README_JA.md                     # 日本語 版本
├── README_KO.md                     # 한국어 版本
├── README_ES.md                     # Español 版本
├── LICENSE                          # MIT License
├── assets/
│   └── demo.gif                     # 功能演示动画
├── references/
│   ├── readme-template.md           # 高星项目 README 模板
│   └── style-guide.md               # 写作风格规范
└── .claude/
    └── commands/
        └── publish.md              # /publish 命令定义

写作规范参考

生成的 README 遵循以下规范:

标题规范

  • 使用 emoji 开头:🚀 快速开始、📋 配置项、💡 使用示例
  • 避免标题过长,保持简洁有力

语言风格

  • 专业但不生硬,像真人写的
  • 每句话都有信息量
  • 英文为主,中文辅助

代码块规范

  • 所有代码块必须标注语言
  • 代码示例必须可以直接运行
  • 关键行添加注释说明

列表规范

好的列表:

  • 3 种预设主题:深色、浅色、高对比
  • 支持 12 种输出格式:PDF、Markdown、HTML 等

差的列表:

  • 功能强大
  • 使用方便

配置表格

参数类型默认值说明
modelstringclaude-sonnet-4使用的 AI 模型
languagestringzh输出语言

配置你的 GitHub Token

为了让 Skill 能够推送代码到 GitHub,你需要配置 GitHub Personal Access Token:

Claude Code / Codex / Cursor

  1. 创建 GitHub Personal Access Token:

  2. 配置凭据:

方法 A:添加到 Git remote URL

git remote add origin https://YOUR_TOKEN@github.com/JUJING-DEEP/repo.git

方法 B:使用 gh auth

gh auth login

Hermes Agent

参考 Hermes Agent 文档 配置 GITHUB_TOKEN 环境变量。

其他 Runtime

参考各 runtime 的文档配置 GitHub 凭据。通常需要在对应配置文件中设置 github_token 或环境变量 GITHUB_TOKEN。


注意事项

  1. 如果 Skill 已有 README:先对比差异,只更新缺失部分
  2. 如果 git push 失败:检查 remote 配置和 Token 权限
  3. 生成的文档语气:要专业但不生硬,像真人写的一样
  4. 信息源黑名单:不包含知乎、微信公众号等低质量来源

背后的故事

每次创建新 Skill 后,编写 README 是最枯燥的重复性工作。GitHub Publisher Skill 将这个过程自动化,让你只需一行命令,就能获得:

  • ✅ 完整的功能介绍
  • ✅ 可运行的代码示例
  • ✅ 清晰的配置说明
  • ✅ 规范的目录结构说明
  • ✅ 符合国际开源社区标准的格式

一行命令,多出来的时间去创造真正的价值。


关于作者

巨鲸r — AI Native Developer · 全网同号

平台链接
🐧 公众号巨鲸r
𝕏 Twitter@JUJING_DEEP
GitHubJUJING-DEEP

扫码关注公众号,获取更多 AI 技能和工具分享 ↓


其他语言 / Other Languages / 他の言語 / 다른 언어 / Otros Idiomas:

English · 日本語 · 한국어 · Español

许可证

MIT — 随便用,随便改,随便分发。


创建 Skill 是开始。自动生成文档是标配。用 GitHub Publisher 让你的 Skill 发行更专业。

MIT License © JUJING-DEEP

Ver o original no GitHub

Bom para

Relacionados