thlorenz/doctoc

Feature request: specify minimum header level

Open

#140 aberto em 22 de fev. de 2018

Ver no 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.

Guia do colaborador

Pilha de tecnologia
javascriptnodejs
Domain
documentationcli
Tipo Issue
feature
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 hours
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
JavaScript
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70
Direção de pesquisa
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.