SuperAPI AI 工具集

mintlify-docs-updater

写作与研究

查看项目

更新于 10-15 21:37

技能介绍

用途:将用户提供的 Markdown 内容导入本仓库的 Mintlify 文档树,强制补齐必需的 frontmatter,并同步更新 docs/docs.json 的导航条目。适合被要求新增、更新或整理 docs/ 下文档页面时使用。

主要能力:读取 references/docs-structure.md 中的站点地图;确定目标页面路径(如 core/new-feature 对应 docs/core/new-feature.md);通过脚本确定性地放置页面并更新导航;支持指定分组与子分组,并可在已有页面之后插入。

使用方式:先查看 references/docs-structure.md 了解当前导航与目录结构,再决定目标路径。导入命令示例:python3 scripts/ingest_markdown_doc.py --source /absolute/path/to/upload.md --page core/new-feature --group "Core"。在 core/models 下新增页面时加 --subgroup "Models";位置不确定时先加 --dry-run 预览。插入到已有页面之后可用 --insert-after /core/models/kimi。完成后需验证:docs/ 下新文件存在、docs/docs.json 在正确分组中包含新的 "/path/to/page" 条目、frontmatter 含 title 与 description。

编辑规则:页面文件放在 docs/<section>/<slug>.md;docs/docs.json 中的页面引用使用绝对文档路由(如 "/core/concepts");frontmatter 保持精简,title 与 description 必需,icon 可选;保留已有的 Mintlify 组件与 JSX 块;Markdown/HTML 块中的图片路径使用 /docs/images/<file>。

参考文件:references/docs-structure.md 为当前导航地图与目录结构;references/content-format.md 为新页面 frontmatter 与内容约定;scripts/ingest_markdown_doc.py 为确定性导入/更新脚本。

限制:资料未提供该技能的收费、价格、平台支持范围及效果说明,暂未提供。