Skip to content

barbecusaury/github-technical-weekly-report

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 

Repository files navigation

GitHub技术周报

中文 | English

github-technical-weekly-report 是一个通用 AI agent skill,用于生成、维护和发布单文件版 GitHub 技术周报 HTML。它面向 GitHub 一周热榜、一个月热榜和飙升榜这类排行榜页面,要求产物可以直接打开,内联 CSS/JS,不依赖本地构建流程。

通用性说明

这个 skill 的核心是 SKILL.mdreferences/,不绑定某一个 agent 平台。只要你的 agent 支持读取 Markdown skill、编辑文件、运行本地检查、并通过 GitHub connector、Git CLI 或已登录浏览器发布内容,就可以复用。

agents/openai.yaml 是 OpenAI/Codex 的可选 UI 元数据,用于显示名称、短描述和默认提示词;其他平台可以忽略它,只读取 SKILL.md

适用场景

  • 每周生成 GitHub 技术排行榜单页。
  • 修复或增强已有 HTML 周报页面。
  • 给周报增加简体中文、繁体中文和英语切换。
  • 维护榜单项目摘要、弹窗项目介绍、作用说明和使用建议的本地化。
  • 上传报告或 skill 到 GitHub,并在远端页面验证文件存在。

关键能力

  • 保持技术编辑类排行榜视觉风格,避免营销页式卡片堆砌。
  • 支持三类榜单:一周内热榜、一个月内热榜、飙升榜。
  • 支持榜单前 10 直接展示、第 11 到 20 名折叠展开。
  • 弹窗支持关闭按钮、点击遮罩关闭、Esc 关闭和键盘可访问性。
  • 中文 locale 下,列表摘要和弹窗“项目介绍”都会走本地化内容,不回退显示英文。
  • 验证 HTML 文件存在、内联脚本可解析、语言按钮存在、交互钩子存在。

仓库结构

.
├── SKILL.md
├── agents/
│   └── openai.yaml
└── references/
    ├── github-upload-via-chrome.md
    ├── intro.en.md
    ├── intro.zh-CN.md
    └── intro.zh-Hant.md

使用方式

在支持 skill 的 agent 中调用或加载 github-technical-weekly-report,并提供目标 HTML 文件,或说明要新生成一份 GitHub 周报。修改后应运行项目内验证脚本;如果要发布到 GitHub,应确认目标仓库、分支和文件路径,再通过 GitHub connector、Git CLI 或网页上传。

本地验证建议

node scripts\verify-report.mjs

如果只使用本 skill 仓库,可重点检查 SKILL.mdagents/openai.yamlreferences/ 是否完整;真正的 HTML 报告验证脚本通常位于调用该 skill 的周报项目中。


English

中文 | English

github-technical-weekly-report is a portable AI-agent skill for creating, maintaining, and publishing a standalone GitHub technical weekly report as a single HTML file. It is designed for leaderboard-style reports covering weekly trending repositories, monthly trending repositories, and fast-rising repositories. The output should open directly in a browser with inline CSS and JavaScript, without a local build step.

Portability

The portable core is SKILL.md plus the references/ directory. It does not require one specific agent platform. Any agent that can read Markdown skills, edit files, run local checks, and publish through a GitHub connector, Git CLI, or authenticated browser can reuse it.

agents/openai.yaml is optional OpenAI/Codex UI metadata for display name, short description, and default prompt. Other platforms can ignore it and read SKILL.md directly.

Use Cases

  • Generate a weekly GitHub technical leaderboard page.
  • Fix or enhance an existing HTML weekly report.
  • Add Simplified Chinese, Traditional Chinese, and English language switching.
  • Maintain localized repository summaries, modal project introductions, problem statements, and usage guidance.
  • Publish the report or the skill to GitHub and verify the files on the remote repository page.

Key Capabilities

  • Preserves a restrained technical-editorial leaderboard style instead of a marketing landing-page layout.
  • Supports three report sections: weekly trending, monthly trending, and surging repositories.
  • Shows the top 10 entries directly and folds ranks 11-20 behind an expandable disclosure.
  • Keeps modal interactions accessible: close button, backdrop click, Esc key, and keyboard focus handling.
  • Ensures Chinese locales use localized list summaries and modal "Project brief" content instead of falling back to English.
  • Verifies that the HTML file exists, inline scripts parse, language buttons exist, and key interaction hooks are present.

Repository Structure

.
├── SKILL.md
├── agents/
│   └── openai.yaml
└── references/
    ├── github-upload-via-chrome.md
    ├── intro.en.md
    ├── intro.zh-CN.md
    └── intro.zh-Hant.md

Usage

Ask a skill-capable agent to load github-technical-weekly-report, then provide the target HTML file or request a new GitHub weekly report. After editing, run the project verification script. If publishing to GitHub, confirm the target repository, branch, and file paths before using a GitHub connector, Git CLI, or browser upload.

Local Verification

node scripts\verify-report.mjs

If you are only working with this skill repository, focus on checking that SKILL.md, agents/openai.yaml, and references/ are complete. The actual HTML report verification script usually lives in the project that uses this skill.

About

Codex skill for generating and publishing the GitHub技术周报 HTML leaderboard report.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors