Md Toc
Documentsmd-tocMd Toc is an Agent Skill for documents published in the nubjs/nub repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Navigate large markdown files efficiently — get a complete heading TOC with exact line ranges, then Read only the section you need instead of loading the whole file.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/nubjs/nub/blob/HEAD/.claude/skills/md-toc/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/md-toc, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
md-toc — markdown navigation via line ranges
When a markdown file is large (>200 lines), don't Read the whole thing. Run the TOC script first to see every heading and its section's line range, then use Read with offset + limit to jump straight to the section you need.
Invocation
node scripts/md-toc/index.mjs <file.md>
# or equivalently:
nub scripts/md-toc/index.mjs <file.md>
Output format
One line per heading, indented by depth, with the section's line range:
L1-402 # Nub — Final-Polish Orchestration Tracker
L152-192 ## Status board
L282-367 ## Item cards
L284-292 ### A — Settle/verify env-plumbing · todo
The range L152-192 means the "Status board" section occupies lines 152–192. To read it:
Read(file, offset=152, limit=41) # limit = end - start + 1
A heading's section spans from its own line to just before the next heading of equal or higher level (or EOF). # lines inside fenced code blocks are correctly ignored (uses a real markdown AST parser, not regex).
When to use
- Any file >200 lines where you need one section, not the whole file.
- HANDOFF/STATUS trackers, AGENTS.md, architecture docs, long epics.
- Before dispatching a sub-agent that needs a slice of a large doc — run the TOC yourself, embed the relevant offset/limit in the prompt so the agent Reads precisely.