Skip to content

docs(readme): 改为插件总览卡片,维护说明移到 CONTRIBUTING - #15

Merged
xiaoyumuxi merged 1 commit into
mainfrom
docs/readme-plugin-overview
Oct 20, 2026
Merged

xiaoyumuxi merged 1 commit into
mainfrom
docs/readme-plugin-overview

Conversation

@xiaoyumuxi

@xiaoyumuxi xiaoyumuxi commented Oct 20, 2026 •

Copy link
Copy Markdown
Collaborator

改动

README 改为插件总览

  • 新增 scripts/render-readme.mjs:根据 lithe-plugin-index.json 生成 README 中 plugins:start / plugins:end 标记之间的内容。
  • 两列卡片,每张卡片包括:图标、名称(链接到插件仓库)、作者、最新版本、API 版本(API 3 会列出 requires 能力)、分类、支持平台、GitHub stars 徽章和标签。
  • 顶部按分类计数(全部 / 语言支持 / 构建工具……),分类取自 tags。
  • 描述优先用 zh-Hans,超过 110 字会截断;没有 icon 的插件使用新增的 assets/plugin-default.svg。
  • README 保留:简介、风险提示、在 Lithe 中安装、贡献入口、许可。

原 README 内容移到 CONTRIBUTING.md

  • 新增章节:索引如何工作、社区插件与官方插件、文档表、仓库结构、本地校验。
  • 规则里新增一条:修改索引后要运行 node scripts/render-readme.mjs。

CI 与自动化

  • validate.yml:新增 render-readme.mjs --check,README 与索引不一致时失败。
  • track-releases.yml:追踪到新版本后重新生成 README,并一起提交到 bot PR。
  • store.test.mjs:新增 3 个测试,覆盖 HTML 转义和默认图标、分类/平台/截断辅助函数、缺少标记时报错。

关联

验证

  • node --test scripts/store.test.mjs:47 个测试全部通过
  • node scripts/render-readme.mjs --check 通过
  • 用 GitHub Markdown API 渲染后截图检查过卡片布局

- README 按索引生成插件卡片(图标、作者、版本、API、分类、平台、stars、标签)
- 新增 scripts/render-readme.mjs 及测试,validate 检查 README 与索引一致
- track-releases 追踪到新版本时同时更新 README
- 索引原理、官方/社区对比、文档表、仓库结构、本地校验移到 CONTRIBUTING.md
- 新增无图标插件使用的默认图标 assets/plugin-default.svg
@xiaoyumuxi
xiaoyumuxi merged commit 126ac97 into main Oct 20, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant