SuperAPI AI 工具集

starlight-handbook-kit

写作与研究

查看项目

更新于 10-15 21:09

技能介绍

用途:本技能用于搭建或扩展面向决策的工程手册站点(Astro + Starlight 静态站)。两种模式:Mode A 从零脚手架新站;Mode B 向已符合该模式的站点新增一个主题簇或单个主题页。

主要能力:每个主题使用固定九段骨架,顺序为 Overview、Mental model、Types / Variants、When to use / When NOT、Tradeoffs、Diagram、Try it、Real-world examples、Further reading,不得增删改名或调序。图表必须用 <Mermaid code={...} /> 组件,不能用围栏 ```mermaid。交互组件从 ../../../components/ 导入并传 client:visible。九项 CI 校验在 npm run verify 中运行:verify:template、verify:pages、verify:frontmatter、verify:skeleton、verify:a11y、verify:artifacts、verify:links、verify:mermaid、verify:freshness。

使用方式:先定位技能基目录并验证 assets 或 scripts 存在,例如 SKILL_DIR=$(find ~/.claude ~/.config ~/.agents -type d -name 'starlight-handbook-kit' 2>/dev/null | head -1)。Mode A:读 PARAMETERS.md 确定五个占位值,复制脚手架 cp -R "$SKILL_DIR/assets/templates/scaffold/." <target-repo>/,替换所有 {{PLACEHOLDER}},再执行 npm install 与 npm run verify。项目页 base 设为 /<repo>,用户根页设为空。Mode B:复制 templates/topic.mdx 到 src/content/docs/<cluster>/<topic-slug>.mdx,填写 frontmatter 的 title、description、last_reviewed(ISO 日期),可选 volatility(stable 为 24 个月,volatile 为 12 个月),补全九段,并在 astro.config.mjs 注册页面后运行 npm run verify。

适用场景:从零建立手册或知识库站点,向已有站点新增主题簇或单页。

限制:日期缺失或格式错误会导致 freshness 校验失败,页面仅超期则警告;不要删除 _demo/widgets.mdx,a11y/无 JS 校验依赖其构建产物;修改九段骨架需提升 templates/topic.mdx 中的 TEMPLATE_VERSION。面向用户的说明文字建议用约 80% ASD-STE100 简化技术英语。收费、价格与效果等未提供。