SuperAPI AI 工具集

adding-documentation-pages

写作与研究

查看项目

更新于 10-15 20:28

技能介绍

用途:为 Coolify 文档站点创建新的文档页面,覆盖指南、教程、知识库文章和故障排查内容。若需编写 docs/services/ 下的服务页或一键服务文档,应改用 adding-service-documentation 技能。

主要能力:按文档分区创建页面,包括 Get Started(docs/get-started/)、Applications(docs/applications/)、Databases(docs/databases/)、Knowledge Base(docs/knowledge-base/)、Troubleshoot(docs/troubleshoot/)、Integrations(docs/integrations/)。支持添加 frontmatter、标题层级、图片与链接,并在需要时更新侧边栏。

使用方式:在对应分区目录创建文件,文件名使用小写 kebab-case(如 my-guide.md);添加包含 title 和 description 的 frontmatter;用清晰标题撰写内容;必要时更新 docs/.vitepress/config.mts 中的侧边栏(约第 130 行起);图片使用 <ZoomableImage> 组件。小图标用标准 markdown 图片语法,截图或大图用 <ZoomableImage>,优先 .webp 格式并使用绝对路径(/docs/images/...)。内部链接用绝对路径,外部链接需加 ?utm_source=coolify.io。

验证清单:frontmatter 含 title 与 description;截图使用 <ZoomableImage>;外部链接带 UTM 参数;页面已加入侧边栏(如适用);可在 http://localhost:5173/docs/[path] 正常渲染。

详细参考:TEMPLATES.md、SIDEBAR.md、FRONTMATTER.md、IMAGES.md、LINKS.md、CONTAINERS.md。相关技能:adding-service-documentation、renaming-services、disabling-services。

限制:资料未提供该技能的安装命令、收费方式与平台支持信息。