SuperAPI AI 工具集

ship-docs

前端与建站

查看项目

更新于 10-27 13:09

技能介绍

ship-docs 是一个面向文档构建与发布的技能,隶属于 trailhq/trail-code。其核心用途是帮助用户在需要「ship 或 publish 文档」时,完成文档站点的构建与上线流程。

【用途】 当文档内容完成修改并需要对外发布时,通过该技能执行构建与发布操作。

【主要能力】 资料明确列出两个命令:make docs 用于构建文档站点,make publish-docs 用于发布文档。二者组合构成发布流程。资料未说明构建产物形式、发布目标渠道以及是否支持增量发布等细节,这些信息暂未提供。

【使用方式】 按资料给出的顺序操作:先运行 make docs,再运行 make publish-docs。特别提示需优先运行 make docs-check 进行检查,原因是断链会导致发布失败。资料未说明这三个 make 目标的具体参数、输出日志格式或失败后的处理步骤,暂未提供。

【适用场景】 适用于项目文档需要构建并对外发布的工作流场景,尤其适合已在项目内配置好相应 Makefile 目标的仓库。

【限制】 存在断链时发布会失败,因此发布前必须通过 docs-check 检查。资料未提及收费、平台支持范围、并发发布或权限要求,均暂未提供。