thlorenz/doctoc

Feature request: specify minimum header level

Open

#140 opened on Feb 22, 2018

View on GitHub
 (4 comments) (5 reactions) (0 assignees)JavaScript (486 forks)batch import
feature requesthelp wanted

Repository metrics

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

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

Research direction
Look at how the maximum heading level option is implemented and add a similar minimum heading level option.
Tech stack
javascript
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80