thlorenz/doctoc

Feature request: specify minimum header level

Open

#140 geöffnet am 22. Feb. 2018

Auf GitHub ansehen
 (3 Kommentare) (5 Reaktionen) (0 zugewiesene Personen)JavaScript (4.106 Stars) (511 Forks)batch import
feature requesthelp wanted

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
JavaScript
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70
Research-Richtung
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.