技能 markdown-toc
📦

markdown-toc

安全 ⚙️ 外部命令

Generate Table of Contents for Markdown

Manually creating and updating Table of Contents in markdown files is time-consuming and error-prone. This skill automatically generates and updates TOCs by parsing headers, supporting batch processing, configurable depth levels, and smart insertion modes.

支援: Claude Codex Code(CC)
📊 69 充足
1

下載技能 ZIP

2

在 Claude 中上傳

前往 設定 → 功能 → 技能 → 上傳技能

3

開啟並開始使用

測試它

正在使用「markdown-toc」。 python scripts/generate_toc.py README.md

預期結果:

  • ## Table of Contents
  •  
  • - [Installation](#installation)
  • - [Usage](#usage)
  • - [Basic Usage](#basic-usage)
  • - [Advanced Usage](#advanced-usage)
  • - [Contributing](#contributing)

正在使用「markdown-toc」。 python scripts/generate_toc.py --no-title docs/guide.md

預期結果:

  • - [Getting Started](#getting-started)
  • - [Configuration](#configuration)
  • - [Troubleshooting](#troubleshooting)

安全審計

安全
v6 • 1/23/2026

All 80 static findings are false positives. The 74 external_command detections are documentation code blocks showing bash examples (e.g., `python scripts/generate_toc.py`). The 6 weak_crypto detections are misidentified table formatting patterns. This is a documentation-only skill with no executable code or malicious patterns. Safe for publication.

1
已掃描檔案
264
分析行數
1
發現項
6
審計總數

風險因素

⚙️ 外部命令 (17)
SKILL.md:12-24 SKILL.md:52-54 SKILL.md:60-62 SKILL.md:68-70 SKILL.md:80-82 SKILL.md:87-89 SKILL.md:92-94 SKILL.md:97-99 SKILL.md:105-114 SKILL.md:118-124 SKILL.md:128-130 SKILL.md:148-150 SKILL.md:160-162 SKILL.md:199-201 SKILL.md:223-227 SKILL.md:231-234 SKILL.md:238-244
審計者: claude 查看審計歷史 →

品質評分

38
架構
100
可維護性
87
內容
19
社群
100
安全
91
規範符合性

你能建構什麼

Update all project documentation

Generate a complete table of contents for all markdown files in a project repository. Perfect for maintaining consistent navigation across large documentation sets.

Create README navigation

Add a clean table of contents to project README files. Helps users quickly navigate to relevant sections without scrolling through entire documents.

Standardize documentation markers

Add consistent TOC markers across multiple documentation files. Ensures uniform structure when building multi-page documentation guides.

試試這些提示

Generate basic TOC 
Generate a table of contents for README.md with headers H2 and H3.
Batch process with preview 
Preview the TOC changes without applying them.
Recursive documentation update 
Generate a table of contents for all markdown files in the docs/ directory recursively.
Custom header levels 
Generate a TOC with only H2 headers for the contributing guide, and H2-H4 for the main README.

最佳實務

  • Always use --dry-run first to preview changes before applying them
  • Use --insert marker mode for precise TOC placement in complex documents
  • Set appropriate --max-level to avoid overly detailed TOCs in large files

避免

  • Running without preview on important documentation files
  • Using deep header levels that create excessively long TOCs
  • Forgetting to update TOCs after restructuring documentation

常見問題

What header levels are included by default?
By default, the TOC includes H2 and H3 headers. Use --min-level and --max-level to customize this range.
Can I generate a TOC without modifying the file?
Yes, use --dry-run to preview the TOC without applying any changes to the file.
How does the auto insertion mode work?
Auto mode searches for existing TOC sections first, then YAML frontmatter, then the first header, or inserts at the top of the file.
Can I process multiple files at once?
Yes, pass multiple file paths, use glob patterns like docs/*.md, or use --recursive to process all markdown files in a directory tree.
What anchor format is generated?
The script generates GitHub-compatible anchors: lowercase, spaces to hyphens, special characters removed, multiple hyphens collapsed.
Is the script portable to other projects?
Yes, the script has no hardcoded paths and works with any markdown file. You can copy it to any project.

開發者詳情

作者

Emasoft

授權

MIT

儲存庫

https://github.com/Emasoft/ghe-marketplace/tree/main/plugins/marketplace-utils/skills/markdown-toc

引用

main

檔案結構

📄 SKILL.md