thlorenz/doctoc

Feature request: specify minimum header level

Open

#140 geöffnet am 22. Feb. 2018

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

Repository-Metriken

Stars
 (4.106 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 18T 3h) (14 gemergte PRs in 30 T)

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

Research-Richtung
Untersuche die vorhandene Option für die maximale Überschriften Tiefe, wahrscheinlich in `lib/doctoc.js` oder einer ähnlichen Datei. Füge eine neue Option `min level` hinzu, die Überschriften unterhalb einer bestimmten Ebene herausfiltert. Berücksichtige, wie sie mit der vorhandenen Option für die maximale Tiefe interagiert. Stelle sicher, dass Tests hinzugefügt und die Dokumentation aktualisiert wird.
Tech Stack
javascript
Domain
documentationcli
Issue Type
Funktion
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 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80