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

readme: remove ToC, since it's now shown by GitHub #1429

Merged
merged 1 commit into from Nov 2, 2021

Conversation

umarcor
Copy link
Contributor

@umarcor umarcor commented Jun 29, 2021

GitHub shows a ToC for any markdown document (not only the README). Therefore, it's not worth the maintainance burden of keeping the ToC in the README up to date manually. This PR removes it.

jpmcb
jpmcb approved these changes Nov 2, 2021
Copy link
Collaborator

@jpmcb jpmcb left a comment

Nice - thanks much for the cleanup! 🚀

@jpmcb jpmcb merged commit f09e947 into spf13:master Nov 2, 2021
11 checks passed
@umarcor umarcor deleted the notoc branch Nov 2, 2021
@marckhouzam
Copy link
Collaborator

marckhouzam commented Nov 3, 2021

I should have checked this sooner, but I don't see any ToC on the main page. Maybe it is a setting of mine?
@umarcor can you let me know where this ToC automatically shown by GitHub can be seen?

@umarcor
Copy link
Contributor Author

umarcor commented Nov 3, 2021

@marckhouzam it's at the top, right next to the filename:

image

It's available for all markdown sources, not only the README. For instance:

image

@marckhouzam
Copy link
Collaborator

marckhouzam commented Nov 3, 2021

Wow. Never noticed this before! Thanks

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

Successfully merging this pull request may close these issues.

None yet

3 participants