large-file-toc

Harryoung's avatarfrom Harryoung

为大文件生成目录概要。当入库的 Markdown 文件超过阈值(默认30KB)时,提取标题结构创建导航文件。触发条件:Markdown 文件大小 >= 30KB。

⭐9stars🔀1forks📁View on GitHub🕐Updated Dec 22, 2025

When & Why to Use This Skill

This Claude skill automates the generation of structural overviews for large Markdown files. By monitoring file size and extracting heading hierarchies, it creates dedicated navigation files that enhance document readability and streamline information retrieval in complex knowledge bases.

Use Cases

  • Technical Documentation Management: Automatically generate navigation for extensive API references or system manuals exceeding 30KB to help developers locate specific sections quickly.
  • Knowledge Base Optimization: Improve the accessibility of long-form research notes or internal wikis by providing a clear, linked table of contents for every large document.
  • Project README Maintenance: Ensure that comprehensive project documentation remains navigable by automatically updating structural overviews as the content grows.
namelarge-file-toc
descriptionGenerate table of contents overview for large files. When onboarded Markdown file exceeds threshold (default 30KB), extract heading structure to create navigation file. Trigger condition: Markdown file size >= 30KB.

Large File Table of Contents Overview Generation

Generate table of contents overview for large Markdown files for quick user navigation.

Applicable Conditions

  • Markdown file size >= 30KB
  • Automatically triggered at onboarding stage 5 (write and update)

Quick Workflow

  1. Extract headings: Use Grep to search ^#+\s+.*$
  2. Generate overview: Create contents_overview/{filename}_overview.md
  3. Update README: Record overview file path

Grep Extract Headings

grep -n '^#' knowledge_base/path/to/file.md

Output example:

10:# Chapter 1 Introduction
150:## 1.1 Background
180:## 1.2 Objectives
400:# Chapter 2 Methodology

Table of Contents Overview Format

See TOC_TEMPLATE.md

README Update Format

- [filename.md](path/to/file.md) (XXX KB) - Brief description [Table of Contents](contents_overview/filename_overview.md)