thlorenz/doctoc

Subsection

Open

#78 opened on Aug 6, 2015

View on GitHub
 (3 comments) (1 reaction) (0 assignees)JavaScript (486 forks)batch import
feature requesthelp wanted

Repository metrics

Stars
 (4,460 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Study the current TOC generation code and adjust it to only include headings that are under the same parent section as the TOC placeholder.
Tech stack
javascript
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75