lifeparticle / binarytree

🕰 We Provide an Array of Developer Productivity Tools Designed To Help You Save Time
https://binarytree.dev
Apache License 2.0
37 stars 13 forks source link

Prevent certain headings from being included in the table of contents (TOC) in Markdown #426

Open lifeparticle opened 9 months ago

lifeparticle commented 9 months ago

Is your feature request related to a problem? Please describe. My main issue is the inability to exclude certain headings from the TOC.

Describe the solution you'd like I would like a feature that allows for more flexible control over which headings are included in the TOC. Ideally, this could be achieved through simple annotations or tags in the Markdown syntax, allowing users to specify which headings should or should not be included in the TOC. For instance, a tag like

<!-- omit in toc --> 

before a heading could tell the TOC generator to skip that heading.

Describe alternatives you've considered N/A

Additional context This feature would be particularly useful for repositories with extensive documentation, where maintaining a clear and concise TOC is crucial for navigation.