- 📄 SKILL.md
phantom-connect-sdk
Perform a structured code quality review of a single package in this monorepo.
Perform a structured code quality review of a single package in this monorepo.
为任何项目创建完整的文档网站。当被要求时使用此技能: "创建文档", "添加文档", "建立文档网站", "生成文档", "文档化项目", "编写文档", "初始化文档", "添加文档文件夹", "创建文档网站"。生成基于 Movk Nuxt Docs 的网站 包含搜索、深色模式、MCP 服务器和 llms.txt 集成。 --- # 创建文档 为任何项目生成完整的、生产就绪的文档网站。 ## 工作流程 1. **分析** - 检测包管理器、monorepo 结构、读取上下文 2. **初始化** - 使用正确的设置创建文档目录 3. **生成** - 使用模板编写文档页面 4. **配置** - 设置 AI 集成(MCP、llms.txt) 5. **最终化** - 提供后续步骤和正确的命令 --- ## 包管理器参考 从 lock 文件检测,如果未找到则默认使用 npm: | Lock 文件 | PM | 安装 | 运行 | 添加 | |-----------|------|---------|-----|-----| | `pnpm-lock.yaml` | pnpm | `pnpm install` | `pnpm run` | `pnpm add` | | `package-lock.json` | npm | `npm install` | `npm run` | `npm install` | | `yarn.lock` | yarn | `yarn install` | `yarn` | `yarn add` | | `bun.lockb` | bun | `bun install` | `bun run` | `bun add` | 在下面的命令中使用 `[pm]` 作为占位符。 --- ## 步骤 1:分析项目 ### 检测项目结构 ``` 检查: ├── pnpm-workspace.yaml → pnpm monorepo ├── turbo.json → Turborepo monorepo ├── lerna.json → Lerna monorepo ├── nx.json → Nx monorepo ├── apps/ → Apps 目录(monorepo) ├── packages/ → Packages 目录(monorepo) ├── docs/ → 现有文档(避免覆盖) ├── README.md → 主文档源 └── src/ 或 lib/ → 源代码位置 ``` ### 确定文档位置 | 项目类型 | 目标目录 | Workspace 项目 | |--------------|------------------|-----------------| | 标准项目 | `./docs` | N/A | | Monorepo with `apps/` | `./apps/docs` | `apps/docs` | | Monorepo with `packages/` | `./docs` | `docs` | | 现有 `docs/` 文件夹 | 询问用户或 `./documentation` | — | ### 读取上下文文件 | 文件 | 提取 | |------|---------| | `README.md` | 项目名称、描述、功能、使用示例 | | `package.json` | 名称、描述、依赖、仓库 URL | | `src/` 或 `lib/` | 导出的函数、可组合项用于 API 文档 | --- ## 步骤 2:初始化文档 ### 创建目录结构 ```bash # 完整模板
skill-sample/ ├─ SKILL.md ⭐ Required: skill entry doc (purpose / usage / examples / deps) ├─ manifest.sample.json ⭐ Recommended: machine-readable metadata (index / validation / autofill) ├─ LICENSE.sample ⭐ Recommended: license & scope (open source / restriction / commercial) ├─ scripts/ │ └─ example-run.py ✅ Runnable example script for quick verification ├─ assets/ │ ├─ example-formatting-guide.md 🧩 Output conventions: layout / structure / style │ └─ example-template.tex 🧩 Templates: quickly generate standardized output └─ references/ 🧩 Knowledge base: methods / guides / best practices ├─ example-ref-structure.md 🧩 Structure reference ├─ example-ref-analysis.md 🧩 Analysis reference └─ example-ref-visuals.md 🧩 Visual reference
More Agent Skills specs Anthropic docs: https://agentskills.io/home
├─ ⭐ Required: YAML Frontmatter (must be at top) │ ├─ ⭐ name : unique skill name, follow naming convention │ └─ ⭐ description : include trigger keywords for matching │ ├─ ✅ Optional: Frontmatter extension fields │ ├─ ✅ license : license identifier │ ├─ ✅ compatibility : runtime constraints when needed │ ├─ ✅ metadata : key-value fields (author/version/source_url...) │ └─ 🧩 allowed-tools : tool whitelist (experimental) │ └─ ✅ Recommended: Markdown body (progressive disclosure) ├─ ✅ Overview / Purpose ├─ ✅ When to use ├─ ✅ Step-by-step ├─ ✅ Inputs / Outputs ├─ ✅ Examples ├─ 🧩 Files & References ├─ 🧩 Edge cases ├─ 🧩 Troubleshooting └─ 🧩 Safety notes
Skill files are scattered across GitHub and communities, difficult to search, and hard to evaluate. SkillWink organizes open-source skills into a searchable, filterable library you can directly download and use.
We provide keyword search, version updates, multi-metric ranking (downloads / likes / comments / updates), and open SKILL.md standards. You can also discuss usage and improvements on skill detail pages.
Quick Start:
Import/download skills (.zip/.skill), then place locally:
~/.claude/skills/ (Claude Code)
~/.codex/skills/ (Codex CLI)
One SKILL.md can be reused across tools.
Everything you need to know: what skills are, how they work, how to find/import them, and how to contribute.
A skill is a reusable capability package, usually including SKILL.md (purpose/IO/how-to) and optional scripts/templates/examples.
Think of it as a plugin playbook + resource bundle for AI assistants/toolchains.
Skills use progressive disclosure: load brief metadata first, load full docs only when needed, then execute by guidance.
This keeps agents lightweight while preserving enough context for complex tasks.
Use these three together:
Note: file size for all methods should be within 10MB.
Typical paths (may vary by local setup):
One SKILL.md can usually be reused across tools.
Yes. Most skills are standardized docs + assets, so they can be reused where format is supported.
Example: retrieval + writing + automation scripts as one workflow.
Some skills come from public GitHub repositories and some are uploaded by SkillWink creators. Always review code before installing and own your security decisions.
Most common reasons:
We try to avoid that. Use ranking + comments to surface better skills: