kuroco-docs

Kuroco 文档搜索指南

此 Skill 可帮助搜索和查阅 Kuroco 官方文档。

文档的位置和格式

文档随此 Skill 一同提供。位置如下：

请使用与此 SKILL.md 位于同一目录中的 docs/。以下示例中的 docs/ 表示相对于此 Skill 所在目录的路径。请勿依赖客户端专用的环境变量或仓库中的固定路径。

随附文档是发布时的快照。如果文档可能已过时，或在随附文档中找不到相关内容，请查看官方网站（https://kuroco.app/ja/docs/ ）。 更新 Skill 软件包后，随附文档也会更新（更新步骤因安装方式而异，请参阅仓库的 README）。

官方文档的各个页面以按类别整合的文件形式收录。

• 一个整合文件中包含多个官方页面，每个页面都以 # 标题 标题开头
• 页面标题下方有原页面的 slug 和官方网站 URL（https://kuroco.app/ja/docs/...）
• 每个文件开头都有“收录页面”目录
• 较大的分类会拆分为 -1.md、-2.md 等文件（使用 Glob 搜索，例如 tutorials-auth-member*.md）

文件结构

文件	内容
INDEX.md	所有文件的列表和收录页面数
tutorials-*.md	教程（auth-member / frontend / content / api-custom / ai-mcp / ec / form-mail / integration / admin-customize / misc）
reference-*.md	参考资料（api / content / smarty-trigger / mcp-ai / file / misc）
management-*.md	管理界面指南（account / api / campaign / content / ec / integration / member / operation / misc）
faq-*.md	常见问题（content / frontend / api / api-error / admin / email-form / domain / file / login-session / password / smarty / tls / infrastructure / deploy / member / email / assessment / contracts / other）
about.md	Kuroco 概述、价格、限制事项、安全性
troubleshooting.md	故障排除

由于公告和发行说明需要保持时效性，因此不随文档一同提供。如有需要，请参阅官方网站（https://kuroco.app/ja/docs/ ）。

搜索方法

方法 1：使用 Grep 搜索关键词（推荐）

使用全文搜索工具（相当于 Grep）横向搜索整个 docs/，然后使用文件读取工具（相当于 Read，可指定起始行）读取命中文件中相关行附近的内容。如果环境中没有搜索工具，也可以在 Shell 中运行 grep -rn，效果相同。

# キーワードで検索（ファイル特定）
Grep: pattern="エンドポイント" path="docs/"

# 行番号付きで内容を確認 → その行から Read で該当セクションを読む
Grep: pattern="フィルタークエリ" path="docs/" output_mode="content" -n=true

# 元ページのslugがわかっている場合（各ページ見出し直下に slug が記載されている）
Grep: pattern="how-to-use-batch" path="docs/"

# ファイル名で分類を絞る
Grep: pattern="ログイン" path="docs/" glob="tutorials-*.md"

整合文件较大，因此不要使用 Read 读取全文，而应根据 Grep 的行号通过 Read（指定 offset/limit）仅读取所需章节，这样效率更高。页面以 # 标题分隔。

方法 2：通过 INDEX.md 查看文件列表

cat docs/INDEX.md

可以查看每个整合文件中收录了哪些页面。各整合文件开头都有收录页面的目录（标题和 slug）。

按目的快速查阅

目的	参阅位置
API 和端点设置	reference-api*.md（endpoint-settings, filter-query, api-cache）、tutorials-api-custom*.md（configure-endpoint）
身份验证、登录、会员注册	tutorials-auth-member*.md（login, signup, 二步验证, SSO/SAML）
前端集成（Nuxt/Next, SSG）	tutorials-frontend*.md（integrate-kuroco-with-nuxt, beginners-guide, corporate-sample-site-to-ssg）
内容管理和 CSV 批量注册	tutorials-content*.md（adding-a-topics, bulk-upload-in-csv）、management-content*.md
批处理、触发器、Smarty	reference-smarty-trigger*.md（smarty-plugin, trigger-variables）、tutorials-api-custom*.md（how-to-use-batch）
外部服务集成（Slack/SendGrid/Firebase 等）	tutorials-integration*.md、tutorials-form-mail*.md、management-integration*.md
电商和支付（Stripe/Paygent）	tutorials-ec*.md、management-ec*.md
MCP 和 AI 功能（如 Kuroco RAG）	tutorials-ai-mcp*.md、reference-mcp-ai*.md
错误和故障排除	faq-*.md、troubleshooting.md、reference-api*.md（error）
价格、限制事项和基础设施	about.md、faq-contracts.md、faq-infrastructure.md

搜索技巧

1. 日语关键词：エンドポイント、ログイン、コンテンツ
2. 英语关键词：Topics、Member、API、CORS
3. 功能名称和 slug：batch、webhook、trigger、smarty、filter-query
4. 限定分类：tutorials-*（实现方法）、reference-*（规格）、management-*（管理界面）、faq-*（问答）
5. 在回答中附上官方 URL：引用各页面标题下方的“官方页面” URL

文档更新

文档会随插件更新而更新。

/plugin marketplace update diverta-kuroco-skills

面向维护人员的整合文件重新生成步骤，请参阅 scripts/consolidate_docs.py 的 docstring。