thlorenz/doctoc

Subsection

Open

#78 geöffnet am 6. Aug. 2015

Auf GitHub ansehen
 (2 Kommentare) (1 Reaktion) (0 zugewiesene Personen)JavaScript (4.106 Stars) (511 Forks)batch import
feature requesthelp wanted

Beschreibung

Would be great to generate toc under a section e.g.

#Header1

<!-- START doctoc -->
<!-- END doctoc -->

##SubHeader1
##SubHeader2
##SubHeader3

#Header2

Should generate toc for

  • SubHeader1
  • SubHeader2
  • SubHeader3

without Header2

Contributor Guide

Tech Stack
javascriptnodejs
Domain
tooling
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 days
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
understand doctoc's TOC generationfamiliarity with markdown parsing
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40
Research-Richtung
The issue requests generating a table of contents only for headers within a section marked by <! START doctoc > and <! END doctoc > comments. Currently, doctoc generates TOC for the entire file. To implement this, examine the existing TOC generation logic in the codebase (likely in lib/ or main script). Identify how headers are collected and inserted, then modify to only include headers between the start and end comment markers. Check if similar section based TOC generation exists in other tools for reference. Ensure backward compatibility for files without section markers.