thlorenz/doctoc

Subsection

Open

#78 建立於 2015年8月6日

在 GitHub 查看
 (2 留言) (1 反應) (0 負責人)JavaScript (4,106 star) (511 fork)batch import
feature requesthelp wanted

描述

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

貢獻者指南

技術棧
javascriptnodejs
領域
tooling
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
understand doctoc's TOC generationfamiliarity with markdown parsing
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
40
研究方向
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.