thlorenz/doctoc

Feature request: specify minimum header level

Open

#140 ouverte le 22 févr. 2018

Voir sur GitHub
 (3 commentaires) (5 réactions) (0 assignés)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.

Guide contributeur

Stack technique
javascriptnodejs
Domaine
documentationcli
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
JavaScript
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70
Direction de recherche
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.