Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
lifeparticle opened this issue Feb 3, 2024 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@lifeparticle
Copy link
Owner

lifeparticle commented Feb 3, 2024

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.

@lifeparticle lifeparticle added enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Feb 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
Status: Project backlog
Development

No branches or pull requests

1 participant