SuperAPI AI 工具集

okf-site-kit

前端与建站

查看项目

更新于 10-15 21:09

技能介绍

用途:把 OKF(Open Knowledge Format,Google 的智能体可读知识开放规范)v0.1 知识包生成为可浏览的静态网站。OKF 只规定 markdown 加 YAML frontmatter,不附带工具,因此浏览能力由消费方实现,本技能即该消费方。

主要能力:assets/okf_site.py(仅用标准库)读取任意 OKF 知识包,输出完整的 Astro + Starlight 静态站点项目,含全文搜索、导航和 OKF 感知的展示。首页为 splash 式 hero(标题、标语来自根 index 首段或 --tagline),每个顶层章节一张链接卡片;每个 concept 一页,页首显示 OKF 元数据面板(类型徽章、标签、资源链接、更新时间、生产者自定义键),正文内链改写为站点路由,资源从 bundle-assets/ 提供;章节页、Changelog(来自根 log.md)自动生成。Starlight 附带全文搜索(Pagefind)、明暗主题、移动端布局、目录。知识包保持只读,站点是可丢弃的输出。能容错处理未知类型、额外 frontmatter、缺失可选文件和断链,仅打印 WARN: 行。

使用方式:先定位技能的 base 目录,例如 SKILL_DIR=$(find ~/.claude ~/.config ~/.agents -type d -name 'okf-site-kit' 2>/dev/null | head -1)。运行 python3 "$SKILL_DIR/assets/okf_site.py" inspect <bundle> 查看 concept 数量、路由、okf_version 与一致性警告;再运行 python3 "$SKILL_DIR/assets/okf_site.py" generate <bundle> --out <dir>,可用 --title、--tagline、--base、--site、--deploy-workflow 等参数。之后 cd <dir> && npm install && npm run build 必须零错误,可用 npm run preview 抽查首页与一个 concept 页。知识包变更后用相同参数加 --force 重新生成(会覆盖脚手架文件)。输出项目为独立 Astro + Starlight,可自行定制。

适用场景:发布、浏览、查看或分享 OKF 知识包;需要 GitHub Pages 连续发布时可用 --deploy-workflow 在每次推送到 main 时重建。

限制:需要 Python 3.10 或更新版本;空目录树会使 inspect 以 INSPECT_RESULT: EMPTY 失败;生成器面向 OKF v0.1,规范更新时需先更新生成器;对 bundle 源文件的修复问题仅提醒用户,不擅自修改。其余收费、价格、平台细节暂未提供。