AGENT SKILL

markdown-toc-generator

为 Markdown 文件生成结构化目录(TOC)。支持多级标题、自定义锚点、 折叠目录。自动检测标题层级并输出符合 GitHub 风格的锚点链接。 用法:在对话中发送 “生成 TOC” 或附带 Markdown 内容即可。

License 许可
MIT
最近更新
2026-08-21
Stars
★ 0
Forks
1

01 前言 Front Matter

name
markdown-toc-generator
license
MIT
version
1.2.0
description
为 Markdown 文件生成结构化目录(TOC)。支持多级标题、自定义锚点、 折叠目录。自动检测标题层级并输出符合 GitHub 风格的锚点链接。 用法:在对话中发送 “生成 TOC” 或附带 Markdown 内容即可。

02 资源文件 2

03 SKILL.md 正文

Markdown TOC Generator

生成清晰的目录结构,帮助长文档快速导航。

触发条件

  • 用户发送 生成 TOC、toc、目录 等指令
  • 用户粘贴 Markdown 文本并附带“整理标题”类请求

工作流程

  1. 读取用户提供的 Markdown 内容或当前文档缓冲区。
  2. 解析 # 开头的标题行,依据层级生成嵌套列表。
  3. 输出带锚点链接的目录,并附上统计信息(标题数量、层级分布)。

特殊模式

当用户请求带 --recursive 参数时,工具会递归处理引用文件(相对路径),并将结果合并输出。

示例

输入:
# 第一章
## 1.1 简介
## 1.2 方法
# 第二章

输出:
- [第一章](#第一章)
  - [1.1 简介](#11-简介)
  - [1.2 方法](#12-方法)
- [第二章](#第二章)

注意事项

  • 仅处理 Markdown 文本,不读取非文本文件。
  • 不修改原始文档,仅输出目录结果。
  • 所有处理均在本地完成,不访问网络。

参数说明

参数 说明
--recursive 递归处理引用文件
--depth 限定最大标题层级(默认 6)
--no-stats 关闭统计信息输出

04 同仓库更多 Skills