用途:根据当前对话上下文与文件夹内容撰写 Markdown 文档,默认生成 README.md。
主要能力:提供 README.md 的示例结构,包括标题与简短概述、可选图片或视频、架构(高层组件及用途)、项目结构(仅展示文件夹结构)、前置条件、安装、使用、测试、贡献、致谢与许可证等章节。
使用方式:调用时第一个参数为目标文件路径,后续文本作为写作指导;若参数为空,则使用当前目录下的 README.md。写作前可调用 /md-syntax 获取 Markdown 规则与语法,调用 /md-style 获取写作约定与风格;写完后用 /md-lint 对文件进行格式化与检查。文件夹内容范围限于文件参数所在层级及以下(同级与子文件夹),不包含上级目录。
适用场景:为项目或文件夹快速生成结构化文档,尤其适合 README 类文档。
限制:非 README 文档可能不适用该示例结构;资料未提供具体安装命令、依赖版本或运行环境等细节。