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.