awesome

awesome copied to clipboard

Hi!

A recent tweet mentioned following information:

GitHub now automatically creates a table of contents for your README.md files from your headers.

Original tweets:

https://twitter.com/github/status/1376636651963842562?s=21

https://twitter.com/natfriedman/status/1375430850620256257

From the Manifesto page, it says:

Create a table of contents (…)

Do you think that the Manifesto could be updated and stop mentioning the Table of contents anymore?

Thank you!

With that said, should we remove the contents section in the awesome readme in favour of the TOC?

Yeah I agree with you....

On Apr 9, 2021 10:59, "Richie Bendall" @.***> wrote:

With that said, should we remove the contents section in the awesome readme in favour of the TOC?

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/sindresorhus/awesome/issues/1972#issuecomment-816493555, or unsubscribe https://github.com/notifications/unsubscribe-auth/ASPGSRIKNQL3IXTP3N55UDLTH2XWXANCNFSM4Z4CF7JA .

I personally find the table of contents marker harder to find than the Contents section. Anyone who isn't familiar with GitHub won't spot that little hamburger menu.

For now, at least, I prefer to keep the manual TOCs. We can reconsider this at a later point.

I see the value in manual TOCs, but we are already seeing errors in some awesome-lists that result from them (minor lint error in PR #2011 for example). Maintenance might be a long term issue with manual ones.

https://www.fiverr.com/share/3vkpLa

Hi! I am new here

If anyone stumbles across this issue like I did, here's a trick to nudge your readers into using the GitHub builting TOC button:

↖️ Click <img height="16" valign="middle" src="https://i.imgur.com/yFtQXvN.png" /> for TOC

Live in Markdown:
↖️ Click for TOC

Screenshot in README.md file:

The list icon image is from the Octicons github design system thing: https://primer.style/octicons/list-unordered-24

@jcbhmr its not legible in dark mode

@Jogai you're absolutely right! Good catch 👍

Alternative image that I think works:

↖️ Click for TOC

light mode:

dark mode: