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

Relax ToC requirement #207

Open
ParanoidUser opened this issue Feb 28, 2025 · 0 comments
Open

Relax ToC requirement #207

ParanoidUser opened this issue Feb 28, 2025 · 0 comments

Comments

@ParanoidUser
Copy link

ParanoidUser commented Feb 28, 2025

Ahoy @sindresorhus 👋

Requiring an explicit Table of Contents (ToC) feels a bit outdated nowadays. Since 2021, GitHub has been automatically generating ToCs for all Markdown files, which is super handy. While I totally see the value in having a ToC, asking authors to add them manually can make their guides feel cluttered. It would be nice to keep things cleaner and let authors focus more on the content itself. I think we should relax this requirement - but I'd love to hear what others think.

Edit: If the community agrees with this proposal, I'd be happy to submit a PR to change it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant