thlorenz/doctoc

Feature request: specify minimum header level

Open

#140 opened on Feb 22, 2018

View on GitHub
 (3 comments) (5 reactions) (0 assignees)JavaScript (4,106 stars) (511 forks)batch import
feature requesthelp wanted

Description

A missing option that would be useful in my use cases would be to be able to specify a minimum heading level, so that we can ignore level 1 headers for example.

This would compliment the option that sets the maximum header depth also.

Contributor guide

Tech stack
javascriptnodejs
Domain
documentationcli
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Investigate the existing option for maximum header depth, likely in `lib/doctoc.js` or a similar file. Add a new `min level` option that filters out headers below a specified level. Consider how it interacts with the existing max depth option. Ensure tests are added and documentation is updated.