mcpField
U
update-markdown-file-index

update-markdown-file-index

github.com/github文档处理40.5k8.9k 次安装1 天前更新
代码仓库

关于 update-markdown-file-index

用于将指定文件夹的文件索引写入 Markdown 文件的技能。它会检查文档结构、选择合适的索引格式，并验证生成的 Markdown。

主要功能

  1. 01检查现有 Markdown 结构
  2. 02按模式查找文件
  3. 03创建或更新索引
  4. 04提取文件信息
  5. 05保留格式并使用相对路径
  6. 06验证 Markdown 语法

适用场景

  1. 01维护 Markdown 文档中的文件夹索引
  2. 02仓库变更后刷新文件列表
  3. 03将文件整理为列表、表格或分类

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/github/awesome-copilot --skill update-markdown-file-index

安装后在 Claude Code 中输入/update-markdown-file-index确认已加载。

详细介绍

更新 Markdown 文件索引

使用来自文件夹 ${input:folder} 的文件索引/表格更新 markdown 文件 ${file}。

流程

  1. 扫描：读取目标 markdown 文件 ${file} 以了解现有结构
  2. 发现：列出指定文件夹 ${input:folder} 中所有匹配模式 ${input:pattern} 的文件
  3. 分析：判断是否存在可更新的现有表格/索引部分，或创建新结构
  4. 构造：根据文件类型和现有内容生成合适的表格/列表格式
  5. 更新：替换现有部分或添加新的文件索引部分
  6. 校验：确保 markdown 语法有效且格式一致

文件分析

对于每个发现的文件，提取：

  • 名称：根据上下文包含或不包含扩展名的文件名
  • 类型：文件扩展名和类别（例如 .md、.js、.py）
  • 描述：首行注释、标题或推断的用途
  • 大小：文件大小以供参考（可选）
  • 修改时间：最后修改日期（可选）

表格结构选项

根据文件类型和现有内容选择格式：

选项 1：简单列表
## Files in ${folder}

- [filename.ext](path/to/filename.ext) - Description
- [filename2.ext](path/to/filename2.ext) - Description
选项 2：详细表格
| File | Type | Description |
|------|------|-------------|
| [filename.ext](path/to/filename.ext) | Extension | Description |
| [filename2.ext](path/to/filename2.ext) | Extension | Description |
选项 3：分类部分

按类型/类别对文件进行分组，使用单独的部分或子表格。

更新策略

  • 🔄 更新现有：如果表格/索引部分存在，则在保留结构的同时替换内容
  • ➕ 添加新内容：如果不存在现有部分，则使用最合适的格式创建新部分
  • 📋 保留：保持现有的 markdown 格式、标题级别和文档流
  • 🔗 链接：对仓库内的文件链接使用相对路径

部分识别

查找具有以下模式的现有部分：

  • 包含以下内容的标题："index"、"files"、"contents"、"directory"、"list"
  • 包含文件相关列的表格
  • 包含文件链接的列表
  • 标记文件索引部分的 HTML 注释

要求

  • 保留现有的 markdown 结构和格式
  • 对文件链接使用相对路径
  • 在可用时包含文件描述
  • 默认按字母顺序对文件排序
  • 处理文件名中的特殊字符
  • 校验所有生成的 markdown 语法

评论

支持 Markdown