thlorenz/doctoc

Subsection

Open

#78 opened on Aug 6, 2015

View on GitHub
 (2 comments) (1 reaction) (0 assignees)JavaScript (4,106 stars) (511 forks)batch import
feature requesthelp wanted

Description

Would be great to generate toc under a section e.g.

#Header1

<!-- START doctoc -->
<!-- END doctoc -->

##SubHeader1
##SubHeader2
##SubHeader3

#Header2

Should generate toc for

  • SubHeader1
  • SubHeader2
  • SubHeader3

without Header2

Contributor guide

Tech stack
javascriptnodejs
Domain
tooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
understand doctoc's TOC generationfamiliarity with markdown parsing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue requests generating a table of contents only for headers within a section marked by <! START doctoc > and <! END doctoc > comments. Currently, doctoc generates TOC for the entire file. To implement this, examine the existing TOC generation logic in the codebase (likely in lib/ or main script). Identify how headers are collected and inserted, then modify to only include headers between the start and end comment markers. Check if similar section based TOC generation exists in other tools for reference. Ensure backward compatibility for files without section markers.