thlorenz/doctoc

Subsection

Open

#78 ouverte le 6 août 2015

Voir sur GitHub
 (2 commentaires) (1 réaction) (0 assignés)JavaScript (4 106 stars) (511 forks)batch import
feature requesthelp wanted

Description

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

Guide contributeur

Stack technique
javascriptnodejs
Domaine
tooling
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.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 days
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
understand doctoc's TOC generationfamiliarity with markdown parsing
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40
Direction de recherche
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.