SuperAPI AI 工具集

doc-smith-build

前端与建站

查看项目

更新于 10-15 19:53

技能介绍

用途:Doc-Smith 内部技能,把 Doc-Smith Markdown 文档构建为静态 HTML,由其他 doc-smith 技能内部调用,不向用户提及。

主要能力:双模式构建。--nav 从 document-structure.yaml 与 config.yaml 生成导航数据和静态资源,输出 assets/nav.js(window.DS_NAV)、assets/docsmith.css、assets/theme.css、index.html 根重定向及 {lang}/index.html 语言重定向,适用于初始化时或文档结构变更后。--doc 将单篇 MD 构建为完整 HTML,输出 dist/{lang}/docs/{path}.html,负责 Markdown 转 HTML(markdown-it)、套 HTML 骨架、生成内联 TOC、处理图片占位符、把 /assets/ 绝对路径转为相对路径、拼接 CSS 与 nav.js 引用;不负责导航渲染(由 nav.js 客户端完成)和 MD 清理。

用法:生成导航:node skills/doc-smith-build/scripts/build.mjs --nav --workspace .aigne/doc-smith --output .aigne/doc-smith/dist;构建单篇:node skills/doc-smith-build/scripts/build.mjs --doc .aigne/doc-smith/docs/overview/zh.md --path /overview --workspace .aigne/doc-smith --output .aigne/doc-smith/dist。选项含 --nav、--doc <file>、--path <path>(--doc 模式必需)、--workspace/-w(默认 .aigne/doc-smith)、--output/-o(默认 <workspace>/dist)。

限制:路径含 .. 视为非法不转换;workspace 不存在、document-structure.yaml 缺失、MD 文件不存在、--doc 缺 --path 均报明确错误;依赖未安装时需在 scripts 目录执行 npm install。其余细节资料未提供。