Skip to main content

markdown-toc

Extract a Markdown heading tree with line numbers before editing or integrating notes. Use when you need to inspect a long Markdown file quickly and choose the best insertion point instead of editing blind.

Source facts

Repository
huangruiteng/CS-Notes
Last source activity
October 2, 2026 at 07:39
Detected SKILL.md language
English
Stars
4,007
Forks
483

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

File Explorer
3 files

Showing SKILL.md

SKILL.md
Source instructions · Read-only preview
name
markdown-toc
description
Extract a Markdown heading tree with line numbers before editing or integrating notes. Use when you need to inspect a long Markdown file quickly and choose the best insertion point instead of editing blind.
# Markdown TOC ## Use this skill when Use this skill before editing a long Markdown file, especially when you need to: - inspect the heading structure quickly; - choose the best section for new content; - avoid creating redundant sections; or - review nearby lines before patching a note. ## Quick start Resolve `{baseDir}` to this skill’s actual directory, then run the bundled script. It reports ATX (`#`) headings, excluding fenced code; Setext headings and full Markdown parsing are outside its scope: ```bash python3 "{baseDir}/scripts/extract_toc.py" /absolute/path/to/file.md ``` In this repository, common targets include: ```bash python3 "{baseDir}/scripts/extract_toc.py" Notes/Gourmet.md python3 "{baseDir}/scripts/extract_toc.py" "Notes/AI-Agent-Product&PE.md" ``` ## Workflow 1. Run the TOC script on the candidate file. 2. Read the returned heading tree and line numbers. 3. Open the most likely section neighborhood with `sed -n '<start>,<end>p'` or `nl -ba`. 4. Insert into an existing section when possible. 5. Create a new section only when the file truly lacks a clean landing spot. ## Output format The script prints a compact tree like this: ```text TOC -------------------------------------------------- # Title (line 1) ## Section (line 20) ### Subsection (line 42) ```
View on GitHub