Agent skill

Docs I18n

by opentiny in opentiny/genui-sdk

Sync GenUI SDK docs between Chinese and English when adding, editing, renaming, or deleting documentation under docs/.

MITAuto-check passedFrontend & Design

Install Docs I18n

skills CLI
$ npx skills add opentiny/genui-sdk --skill docs-i18n -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install opentiny/genui-sdk docs-i18n --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/opentiny/genui-sdk.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/docs-i18n .claude/skills/docs-i18n && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
docs-i18n
GitHub stars
171
Token cost
~962 tokens
SKILL.md length
241 words
Files
1
Skills in repo
5
Repo updated
First seen
Licence
MIT

At a glance

Sync GenUI SDK docs between Chinese and English when adding, editing, renaming, or deleting documentation under docs/.

  • Works in 7 steps: 编写中文 docs/src/.md → 有交互示例时 → 图片放入 docs/src/public/(中英文共用) → …
  • The user modifies docs/src/
  • SKILL.md covers 目录映射, 工作流程, 英文文档编写规则 and 导航配置对照, plus 2 more sections
  • Calls pnpm

What it does

Docs I18n is an agent skill from opentiny/genui-sdk. Sync GenUI SDK docs between Chinese and English when adding, editing, renaming, or deleting documentation under docs/. Use when the user modifies docs/src/, docs/demos/, docs/demos/en/, zh-theme.ts, en-theme.ts, or asks to update English docs, i18n docs, or mirror Chinese documentation changes.

Its SKILL.md is about 960 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Frontend & Design, covering Internationalization. It works with Vue.js. The repository describes itself as: A Generative UI SDK for Vue, Angular and React. The licence is MIT.

When your agent uses it

  • The user modifies docs/src/
  • Asks to update English docs
  • Mirror Chinese documentation changes

Example prompts

  • “/docs-i18n”

Workflow steps

7 steps, taken from the first numbered list in SKILL.md.

  1. 编写中文 docs/src/.md
  2. 有交互示例时
  3. 图片放入 docs/src/public/(中英文共用)
  4. 在 zh-theme.ts 对应 sidebar 添加条目
  5. 创建并翻译 docs/src/en/.md
  6. 在 en-theme.ts 对应 sidebar 添加条目(链接带 /en 前缀)
  7. 本地预览:cd docs && pnpm dev

What it can do on your machine

Read from SKILL.md and the folder at commit 69578e3. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • pnpm

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use pnpm, which can reach the network depending on how they are called.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Docs I18n loads about 962 tokens when it runs. Until then it costs about 76 tokens; SKILL.md has 241 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~76
When it runs · the whole SKILL.md, loaded when a task matches
~962

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from opentiny/genui-sdk at commit 69578e3, republished under its MIT licence (© opentiny). 241 words, ~962 tokens.

Download SKILL.mdSave it as .claude/skills/docs-i18n/SKILL.md (or your agent's skills folder).
name
docs-i18n
description
Sync GenUI SDK docs between Chinese and English when adding, editing, renaming, or deleting documentation under docs/. Use when the user modifies docs/src/, docs/demos/, docs/demos/en/, zh-theme.ts, en-theme.ts, or asks to update English docs, i18n docs, or mirror Chinese documentation changes.

GenUI SDK 文档国际化

完整约定见仓库根目录 docs/I18N.md。修改中文文档时(共享 demo、仅改图片等例外除外),必须同步英文镜像与导航配置。

目录映射

类型中文英文
Markdowndocs/src/<path>.mddocs/src/en/<path>.md
Demodocs/demos/<path>.vuedocs/demos/en/<path>.vue
图片docs/src/public/(共用,无需复制)同上
中文导航docs/.vitepress/config/zh-theme.ts—
英文导航—docs/.vitepress/config/en-theme.ts

路径规则:

  • 文档:docs/src/examples/chat/foo.md → docs/src/en/examples/chat/foo.md(在 src/ 后插入 en/)
  • Demo:docs/demos/chat/foo.vue → docs/demos/en/chat/foo.vue(在 demos/ 后插入 en/,文件名相同)

工作流程

根据用户操作选择对应流程,完成后执行「验证清单」。

新增文档
  1. 编写中文 docs/src/<path>.md
  2. 有交互示例时:
    • 中文:docs/demos/<name>.vue
    • 含中文 UI/文案时:docs/demos/en/<name>.vue(翻译 UI 文案、alert、Schema label 等;代码注释可翻译或保留)
    • 纯英文、无文本、或 i18n 演示类 demo → 共用中文版,不建 demos/en/ 镜像
  3. 图片放入 docs/src/public/(中英文共用)
  4. 在 zh-theme.ts 对应 sidebar 添加条目:
    ts
    { text: '中文标题', link: '/examples/chat/my-feature' },
  5. 创建并翻译 docs/src/en/<path>.md
  6. 在 en-theme.ts 对应 sidebar 添加条目(链接带 /en 前缀):
    ts
    { text: 'English Title', link: '/en/examples/chat/my-feature' },
  7. 本地预览:cd docs && pnpm dev
修改文档
变更类型同步动作
改正文 / 标题 / 代码块更新 docs/src/en/ 下对应文件(翻译变更部分)
改 demo 引用或逻辑同步 docs/demos/ 与 docs/demos/en/ 中对应 .vue(如有)
改 sidebar 文案或顺序同步更新 zh-theme.ts 与 en-theme.ts 对应条目
仅改图片无需动英文 md(public 共用)
重命名 / 移动
  1. 移动中文 md → 同步移动 docs/src/en/ 下镜像文件
  2. 移动 demo → 同步移动 docs/demos/en/ 下镜像文件(如存在)
  3. 更新 zh-theme.ts 与 en-theme.ts 中所有相关 link
  4. 检查文档内相对路径引用是否仍有效
删除文档
  1. 删除 docs/src/<path>.md
  2. 删除 docs/src/en/<path>.md
  3. 删除关联 demo(docs/demos/ 与 docs/demos/en/ 下对应文件)
  4. 从 zh-theme.ts 与 en-theme.ts 移除对应 sidebar 条目

英文文档编写规则

路径调整(从中文复制时必改)

英文 md 比中文多一层 en/,<demo> 与图片的相对路径需多加一层 ../,并将 demo 路径指向 demos/en/:

markdown
<!-- 中文 docs/src/examples/chat/foo.md -->
<demo vue="../../../demos/chat/foo.vue" />

<!-- 英文 docs/src/en/examples/chat/foo.md -->
<demo vue="../../../../demos/en/chat/foo.vue" />
  • 文档内互相引用:相对路径写法与中文相同
  • sidebar / nav 的 link:英文必须带 /en 前缀(如 /en/guide/quick-start)
翻译原则
  • 翻译自然、技术准确的英文,勿逐字机翻
  • 保留 API 名称、组件名、包名、文件名、路径(如 @opentiny/genui-sdk-vue、GenuiChat)
  • 代码块:仅翻译注释与字符串字面量;结构、导入、类型与中文一致
  • 标题层级、章节顺序、代码块行高亮(如 {12-19})与中文版对齐
Demo 需翻译的内容
类型示例处理
UI 文案<button>新建会话</button>译成英文
代码注释// 获取会话对象翻译或保留
Schema 内容label: '姓名'译成英文
alert 消息alert('复制成功')译成英文
无需国际化的 Demo

以下 demo 无需创建 demos/en/ 镜像,直接共用中文版:

  • 纯英文内容的 demo
  • 国际化示例 demo(如 i18n.vue,本身演示 i18n 功能)
  • 无文本内容的 demo

导航配置对照

两个 theme 文件结构镜像,修改时成对维护:

  • zh-theme.ts:nav / sidebar 的 link 无 /en 前缀
  • en-theme.ts:相同路径结构,link 以 /en 开头;text 为英文

sidebar 按路径前缀分组(/guide/、/components/、/examples/、/schema/、/advanced/),新增条目放入与中文版相同的分组与层级。

验证清单

完成同步后逐项确认:

markdown
- [ ] docs/src/en/ 下存在对应的翻译文件,路径正确
- [ ] zh-theme.ts 与 en-theme.ts 均有对应 sidebar 条目且 link 正确
- [ ] zh-theme.ts 与 en-theme.ts 顶层 nav 映射一致,英文 link 带 /en 前缀
- [ ] 英文 md 中 <demo> 路径多一层 ../,且指向 demos/en/ 下对应文件(如需)
- [ ] demo 含中文内容时已在 docs/demos/en/ 提供镜像
- [ ] 删除场景下无残留英文文件、demo、sidebar 条目
- [ ] 可选:cd docs && pnpm dev 本地预览中英文页面

快速定位镜像文件

text
中文:docs/src/examples/chat/history.md
英文:docs/src/en/examples/chat/history.md

中文 demo:docs/demos/chat/history.vue
英文 demo:docs/demos/en/chat/history.vue

© opentiny, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .agents/skills/docs-i18n of opentiny/genui-sdk.

Open the folder on GitHubat commit 69578e3

Compare with similar skills

Docs I18n next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Docs I18n compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Docs I18n this skillopentiny/genui-sdk171—~962Automated safety check: PassMIT
Create Docsvictorgarciaesgi/nuxt-typed-router4132 repos~2.8kAutomated safety check: PassMIT
Localization Toolkitzebbern/claude-code-guide4.7k1 repos~1.3kAutomated safety check: PassMIT
I18n Vue Templaterundeck/rundeck6.3k—~523Automated safety check: NotesApache-2.0
Vtdfany-tdf/any-tdf779—~1.1kAutomated safety check: PassMIT
Vue Route Breadcrumbschamilo/chamilo-lms1k—~2kAutomated safety check: PassGPL-3.0

Similar skills

  • Create Docs

    victorgarciaesgi/nuxt-typed-router

    Create complete documentation sites for projects. An agent skill from victorgarciaesgi/nuxt-typed-router.

    413 GitHub starsUsed in 2 repos~2.8k tokens
    Frontend & DesignAuto-check passed
  • Localization Toolkit

    zebbern/claude-code-guide

    This skill should be used when setting up, auditing, or enforcing internationalization/localization in UI codebases (React/TS, i18next or similar, JSON locales), including installing/configuring the…

    4.7k GitHub starsUsed in 1 repo~1.3k tokens
    Frontend & DesignAuto-check passed
  • I18n Vue Template

    rundeck/rundeck

    Internationalize Vue component templates by replacing all hardcoded strings with $t() calls and adding translations to i18n.ts or enUS.js.

    6.3k GitHub stars~523 tokensUpdated today
    Frontend & DesignAuto-check: notes
  • Vtdf

    any-tdf/any-tdf

    Build, review, and troubleshoot VTDF Vue 3 applications using exact component APIs, themes, icons, localization, and scaffolding.

    779 GitHub stars~1.1k tokensUpdated today
    Frontend & DesignAuto-check passed
  • Vue Route Breadcrumbs

    chamilo/chamilo-lms

    Gives a route in Chamilo's Vue app its breadcrumb entirely from router meta fields, without editing the Breadcrumb component or naming pages.

    1k GitHub stars~2k tokensUpdated today
    Frontend & DesignAuto-check passed
  • Regle Advanced

    victorgarciaesgi/regle

    Advanced Regle form validation patterns — collection validation with $each, async rules and $pending, server/externalErrors, $reset options, global config with defineRegleConfig, discriminated-union…

    506 GitHub stars~683 tokensUpdated 10 days ago
    Frontend & DesignAuto-check passed

More from opentiny/genui-sdk

  • Release Notes

    opentiny/genui-sdk

    Generate and publish formatted GitHub Release Notes for opentiny/genui-sdk.

    171 GitHub stars~1.4k tokensUpdated today
    Auto-check passed
  • Genui Integration

    opentiny/genui-sdk

    genui-sdk 全方位指南:安装、配置、集成、示例。用户提到 genui-sdk、genui-sdk-server,或想构建 AI 聊天界面、动态 UI 组件、Node.js 后端 LLM 代理(OpenAI 兼容 chat/completions API)时使用。涵盖 Vue/Angular 前端(主题、物料、GenuiChat/GenuiRenderer)与 Server…

    171 GitHub stars~1.3k tokensUpdated today
    Auto-check passed
  • Publicity Article

    opentiny/genui-sdk

    Write GenUI SDK version publicity articles for 掘金, 公众号, and other platforms from release notes.

    171 GitHub stars~1.1k tokensUpdated today
    Auto-check passed
  • Update Docs PR

    opentiny/genui-sdk

    After publishing a new @opentiny/genui-sdk package, update opentiny/docs (submodule, genui package versions, VitePress sidebar) and opentiny/opentiny.design (submodule commit only), then open PRs on…

    171 GitHub stars~819 tokensUpdated today
    Auto-check passed

Works with

Questions about Docs I18n

What does Docs I18n do?

Sync GenUI SDK docs between Chinese and English when adding, editing, renaming, or deleting documentation under docs/. Docs I18n is an agent skill from opentiny/genui-sdk. Sync GenUI SDK docs between Chinese and English when adding, editing, renaming, or deleting documentation under docs/.

When should I use Docs I18n?

Docs I18n fits situations like: the user modifies docs/src/; asks to update English docs; mirror Chinese documentation changes.

How do I install Docs I18n in Claude Code?

Run `npx skills add opentiny/genui-sdk --skill docs-i18n -a claude-code`. Or copy the skill folder (.agents/skills/docs-i18n in opentiny/genui-sdk) into .claude/skills/docs-i18n in your project. Claude Code loads it when a task matches its description.

How do I install Docs I18n in Codex?

Run `npx skills add opentiny/genui-sdk --skill docs-i18n -a codex`. Or copy the skill folder (.agents/skills/docs-i18n in opentiny/genui-sdk) into .agents/skills/docs-i18n in your project. Codex loads it when a task matches its description.

Can I use Docs I18n in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add opentiny/genui-sdk --skill docs-i18n -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/docs-i18n, .gemini/skills/docs-i18n, .github/skills/docs-i18n and .opencode/skills/docs-i18n in your project.

What does Docs I18n need to run?

Going by SKILL.md and its folder, Docs I18n needs the command-line tools its instructions call (pnpm).

Does Docs I18n access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Docs I18n safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Docs I18n use?

Docs I18n is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Docs I18n use?

About 962 tokens (SKILL.md is roughly 3.8k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Docs I18n?

Skills that share tags, products or a category with Docs I18n: Create Docs (victorgarciaesgi/nuxt-typed-router, 413 stars), Localization Toolkit (zebbern/claude-code-guide, 4.7k stars), I18n Vue Template (rundeck/rundeck, 6.3k stars) and Vtdf (any-tdf/any-tdf, 779 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Docs I18n?

opentiny (a GitHub organization) maintains it in opentiny/genui-sdk, which has 171 GitHub stars. The repository holds 5 skills in this directory. The repository was last updated on October 8, 2026.

Source: opentiny/genui-sdk on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.