skills/conardli__garden-skills
1
0
Fork 0
mirror of https://github.com/ConardLi/garden-skills.git synced 2026-09-14 15:56:41 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: update Japanese and localized README files to include new links and documentation

Browse Source
This commit is contained in:
lishiqi.conard
2026-05-11 21:37:43 +08:00
parent 317acc5c08
commit 5a2565627d
8 changed files with 32 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/workflows/release-skill.yml
+5 -5
View File
@@ -12,9 +12,9 @@ name: Release Skill
# 3. Generates release notes from `git log` since the previous tag of this
# same skill (falls back to all-history on the first release).
# 4. Creates a GitHub Release with the zip + sha256 attached.
# 5. Re-renders the inline `Download v<version> .zip` link in README.md /
# README.zh-CN.md via `npm run readme:sync` and pushes the change back
# to the default branch.
# 5. Re-renders the inline `Download v<version> .zip` link in localized
# READMEs via `npm run readme:sync` and pushes the change back to the
# default branch.
#
# See CONTRIBUTING.md for the full release flow (and `cut-release.mjs` which
# automates the maintainer-side bump + tag + push).
@@ -150,13 +150,13 @@ jobs:
npm run readme:sync
if [ -z "$(git status --porcelain README.md README.zh-CN.md)" ]; then
if [ -z "$(git status --porcelain README.md README.zh-CN.md README.ja-JP.md)" ]; then
echo "README already in sync — nothing to commit."
exit 0
fi
git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
git add README.md README.zh-CN.md
git add README.md README.zh-CN.md README.ja-JP.md
git commit -m "docs(readme): sync download links for ${SKILL} v${VERSION}"
git push origin "$DEFAULT_BRANCH"
.github/workflows/validate-skills.yml
+3 -1
View File
@@ -1,7 +1,7 @@
name: Validate Skills
# PR-time guard rails. Runs on every push / PR that touches a skill, the
# release scripts, or either README. Cheap, fast, no side effects.
# release scripts, or any localized README. Cheap, fast, no side effects.
on:
pull_request:
@@ -10,6 +10,7 @@ on:
- "scripts/release/**"
- "README.md"
- "README.zh-CN.md"
- "README.ja-JP.md"
- ".github/workflows/validate-skills.yml"
- "package.json"
push:
@@ -19,6 +20,7 @@ on:
- "scripts/release/**"
- "README.md"
- "README.zh-CN.md"
- "README.ja-JP.md"
- ".github/workflows/validate-skills.yml"
- "package.json"
workflow_dispatch: {}
CONTRIBUTING.ja-JP.md
+6 -5
View File
@@ -76,8 +76,8 @@ npm run validate # CI がすべての PR で実行するのと同じチェッ
├── website/ ← スタンドアロンのショーケースウェブサイト
│
├── package.json ← メンテナースクリプト（ランタイム依存なし）
├── README.md / README.zh-CN.md ← ユーザー向けコレクションインデックス
└── CONTRIBUTING.md / CONTRIBUTING.zh-CN.md ← このファイル
├── README.md / README.zh-CN.md / README.ja-JP.md ← ユーザー向けコレクションインデックス
└── CONTRIBUTING.md / CONTRIBUTING.zh-CN.md / CONTRIBUTING.ja-JP.md ← このファイル
```
---
@@ -92,6 +92,7 @@ npm run validate # CI がすべての PR で実行するのと同じチェッ
├── manifest.json ← 必須: name / version / category / description / compat
├── README.md ← 人間向けの英語ドキュメント（GitHub でレンダリングされるもの）
├── README.zh-CN.md ← 人間向けの中国語ドキュメント
├── README.ja-JP.md ← 人間向けの日本語ドキュメント
├── references/ ← オプション: エージェントがオンデマンドで読み込むドキュメント
├── scripts/ ← オプション: 決定論的な実行可能コード
└── assets/ ← オプション: 出力で使用するテンプレート、フォント、アイコン
@@ -144,7 +145,7 @@ description: このスキルが何をして、いつ使うかを明確に説明
1. 最低でも `SKILL.md` + `manifest.json` を含む `skills/<new-name>/` を作成します。
実験的なものであれば `version: "0.1.0"` から、リリース可能と確信していれば
`1.0.0` から始めます。
2. `README.md` と `README.zh-CN.md` の両方で、新しいスキルの「Links:」/
2. すべてのルート多言語 README で、新しいスキルの「Links:」/
「链接：」行の末尾にインラインの DOWNLOAD マーカーを追加します（先頭に ` · ` を付ける）:
```markdown
Links: [README](...) · [SKILL.md](...) · <!-- DOWNLOAD:<new-name>:start --><!-- DOWNLOAD:<new-name>:end -->
@@ -279,7 +280,7 @@ npm run validate # CI がすべての PR で実行するすべて（list +
### [`validate-skills.yml`](./.github/workflows/validate-skills.yml)
すべての PR と、`skills/**`、`scripts/release/**`、いずれかの README に触れる
すべての PR と、`skills/**`、`scripts/release/**`、いずれかの多言語 README に触れる
`main` へのすべてのプッシュで実行されます。`npm run validate` を実行し、以下を行います:
- すべての `manifest.json` とスキルフォルダの構造を lint
@@ -294,7 +295,7 @@ npm run validate # CI がすべての PR で実行するすべて（list +
2. `skills/<name>/` を `<name>-<version>.zip` + `.sha256` にパック。
3. そのスキルの前のタグ以降の `git log` からリリースノートを生成。
4. zip + sha256 を添付した GitHub リリースを作成。
5. 両方の README のインラインの `Download v<version> .zip` リンクを再レンダリングし、
5. 多言語 README のインラインの `Download v<version> .zip` リンクを再レンダリングし、
変更を `github-actions[bot]` として `main` にコミットして戻す。
両方のワークフローは、ローカルで実行できるのと同じ `npm run *` コマンドを使用します。
CONTRIBUTING.md
+6 -5
View File
@@ -76,8 +76,8 @@ tooling is pure ESM Node, zero deps.
├── website/ ← standalone showcase websites
│
├── package.json ← maintainer scripts (no runtime deps)
├── README.md / README.zh-CN.md ← user-facing collection index
└── CONTRIBUTING.md / CONTRIBUTING.zh-CN.md ← this file
├── README.md / README.zh-CN.md / README.ja-JP.md ← user-facing collection index
└── CONTRIBUTING.md / CONTRIBUTING.zh-CN.md / CONTRIBUTING.ja-JP.md ← this file
```
---
@@ -92,6 +92,7 @@ Every skill in this repo follows the same minimal shape:
├── manifest.json ← required: name / version / category / description / compat
├── README.md ← English docs for humans (this is what GitHub renders)
├── README.zh-CN.md ← Chinese docs for humans
├── README.ja-JP.md ← Japanese docs for humans
├── references/ ← optional: docs the agent loads on-demand
├── scripts/ ← optional: deterministic executable code
└── assets/ ← optional: templates, fonts, icons used in outputs
@@ -145,7 +146,7 @@ For the full SKILL.md spec, see [agentskills.io](https://agentskills.io) and the
Start with `version: "0.1.0"` if it's experimental, or `1.0.0` if you're
confident it's ready.
2. Append the inline DOWNLOAD marker to the end of the new skill's "Links:" /
"链接：" row in both `README.md` and `README.zh-CN.md` (preceded by ` · `):
"链接：" row in every localized root README (preceded by ` · `):
```markdown
Links: [README](...) · [SKILL.md](...) · <!-- DOWNLOAD:<new-name>:start --><!-- DOWNLOAD:<new-name>:end -->
```
@@ -281,7 +282,7 @@ Two workflows, both small:
### [`validate-skills.yml`](./.github/workflows/validate-skills.yml)
Runs on every PR and every push to `main` that touches `skills/**`,
`scripts/release/**`, or either README. It runs `npm run validate`, which:
`scripts/release/**`, or any localized README. It runs `npm run validate`, which:
- lints every `manifest.json` and skill folder structure
- smoke-packs every skill (no upload)
@@ -295,7 +296,7 @@ Triggered by pushing a tag matching `<skill>-v<semver>`. It:
2. Packs `skills/<name>/` into `<name>-<version>.zip` + `.sha256`.
3. Generates release notes from `git log` since the previous tag of that skill.
4. Creates a GitHub Release with the zip + sha256 attached.
5. Re-renders the inline `Download v<version> .zip` link in both READMEs
5. Re-renders the inline `Download v<version> .zip` link in localized READMEs
and commits the change back to `main` as `github-actions[bot]`.
Both workflows use the same `npm run *` commands you can run locally — single
CONTRIBUTING.zh-CN.md
+6 -5
View File
@@ -74,8 +74,8 @@ npm run validate # 跑一遍和 PR CI 完全一样的检查
├── website/ ← 独立展示网站
│
├── package.json ← 维护者脚本（无运行时依赖）
├── README.md / README.zh-CN.md ← 用户向集合首页
└── CONTRIBUTING.md / CONTRIBUTING.zh-CN.md ← 本文件
├── README.md / README.zh-CN.md / README.ja-JP.md ← 用户向集合首页
└── CONTRIBUTING.md / CONTRIBUTING.zh-CN.md / CONTRIBUTING.ja-JP.md ← 本文件
```
---
@@ -90,6 +90,7 @@ npm run validate # 跑一遍和 PR CI 完全一样的检查
├── manifest.json ← 必需：name / version / category / description / compat
├── README.md ← 给人看的英文文档（GitHub 渲染的就是它）
├── README.zh-CN.md ← 给人看的中文文档
├── README.ja-JP.md ← 给人看的日文文档
├── references/ ← 可选：Agent 按需加载的扩展文档
├── scripts/ ← 可选：确定性的可执行代码
└── assets/ ← 可选：模板、字体、图标等输出物素材
@@ -141,7 +142,7 @@ description: 用一句话清楚说明这个 Skill 是干什么的、什么时候
1. 创建 `skills/<new-name>/`，至少要有 `SKILL.md` + `manifest.json`。
实验性的可以用 `version: "0.1.0"` 起步，比较成熟的就直接 `1.0.0`。
2. 在 `README.md` 和 `README.zh-CN.md` 里新 Skill 的"链接：" / "Links:" 行末尾
2. 在所有根目录多语言 README 里新 Skill 的"链接：" / "Links:" 行末尾
追加 inline DOWNLOAD marker（前面加 ` · ` 保持视觉一致）：
```markdown
链接：[README](...) · [SKILL.md](...) · <!-- DOWNLOAD:<new-name>:start --><!-- DOWNLOAD:<new-name>:end -->
@@ -271,7 +272,7 @@ npm run validate # CI 在每个 PR 跑的全套（list + pack:all + readme:
### [`validate-skills.yml`](./.github/workflows/validate-skills.yml)
每个 PR、以及 main 上任何动到 `skills/**` / `scripts/release/**` / 两份 README
每个 PR、以及 main 上任何动到 `skills/**` / `scripts/release/**` / 任一多语言 README
的 push，都会跑。它跑的是 `npm run validate`，等价于：
- lint 每个 `manifest.json` + skill 文件夹结构
@@ -286,7 +287,7 @@ push 一个 `<skill>-v<semver>` 格式的 tag 时触发。流程：
2. 把 `skills/<name>/` 打成 `<name>-<version>.zip` + `.sha256`。
3. 基于该 Skill 上一个 tag 之后的 `git log` 自动生成 release notes。
4. 创建一个带 zip + sha256 的 GitHub Release。
5. 重写两份 README 里这个 Skill 的 `下载 v<版本> .zip` 链接，以
5. 重写多语言 README 里这个 Skill 的 `下载 v<版本> .zip` 链接，以
`github-actions[bot]` 身份 commit 回 `main`。
两个 workflow 跑的是和你本地完全一样的 `npm run *` 命令——单一事实来源。
scripts/release/update-readme.mjs
+4 -2
View File
@@ -1,6 +1,6 @@
#!/usr/bin/env node
// Rewrites the <!-- DOWNLOAD:<skill>:start --> ... <!-- DOWNLOAD:<skill>:end -->
// blocks in README.md and README.zh-CN.md so they always advertise the
// blocks in README.md, README.zh-CN.md, and README.ja-JP.md so they always advertise the
// most recently published version of each skill.
//
// IMPORTANT: the version source is the latest *git tag* for that skill
@@ -12,7 +12,7 @@
// Idempotent: running it twice in a row produces no diff.
//
// Usage:
// node scripts/release/update-readme.mjs # rewrite both READMEs
// node scripts/release/update-readme.mjs # rewrite localized READMEs
// node scripts/release/update-readme.mjs --check # exit 1 if anything would change
// node scripts/release/update-readme.mjs --repo ConardLi/garden-skills
@@ -33,11 +33,13 @@ const DEFAULT_REPO = "ConardLi/garden-skills";
const FILES = [
{ path: path.join(REPO_ROOT, "README.md"), lang: "en" },
{ path: path.join(REPO_ROOT, "README.zh-CN.md"), lang: "zh" },
{ path: path.join(REPO_ROOT, "README.ja-JP.md"), lang: "ja" },
];
const COPY = {
en: { label: "Download v%V .zip", unreleased: "_(no release yet — coming soon)_" },
zh: { label: "下载 v%V .zip", unreleased: "_（暂未发布）_" },
ja: { label: "Download v%V .zip", unreleased: "_（まだリリースされていません）_" },
};
// Per-skill block is intentionally a single inline link — appended to the
skills/web-video-presentation/SKILL.md
+1 -1
View File
@@ -5,7 +5,7 @@ description: 把一篇文章或口播稿，做成"看起来像视频"的点击
# Web Video Presentation
把一篇文章或口播稿，一步步做成可录屏的"伪装成网页的视频"，可选合成
把一篇文章或口播稿，一步步做成可录屏的"伪装成视频的网页"，可选合成
口播音频。产出物 = Vite + React + TS 项目 + 按章节切分的音频。
## 适用场景
skills/web-video-presentation/manifest.json
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "web-video-presentation",
"version": "1.1.3",
"version": "1.1.4",
"category": "Web Video / Presentation",
"description": "Turn scripts, articles, lessons, product demos, and talks into click-driven 16:9 web presentations that can be screen-recorded as cinematic videos. Ships a Vite + React + TypeScript scaffold, a (chapter, step) cursor model, hard collaboration checkpoints, and a theme-token architecture.",
"homepage": "https://github.com/ConardLi/garden-skills/tree/main/skills/web-video-presentation",