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

Manifesto - Table of contents #1972

Open
antleblanc opened this issue Mar 26, 2021 · 11 comments
Open

Manifesto - Table of contents #1972

antleblanc opened this issue Mar 26, 2021 · 11 comments

Comments

@antleblanc
Copy link

antleblanc commented Mar 26, 2021

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!

Repository owner deleted a comment from kiasha94 Apr 5, 2021
@Richienb
Copy link
Contributor

Richienb commented Apr 9, 2021

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

@skyTech-max
Copy link

skyTech-max commented Apr 9, 2021 via email

@morinted
Copy link

morinted commented Apr 9, 2021

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.

@sindresorhus
Copy link
Owner

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

@d-wasserman
Copy link
Contributor

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.

Repository owner deleted a comment from 123456789fariborz Apr 8, 2022
@ROKONUJJAMA
Copy link

@NasirAlbani
Copy link

Hi! I am new here

@jcbhmr

This comment was marked as outdated.

@Jogai
Copy link

Jogai commented May 3, 2023

@jcbhmr its not legible in dark mode

@jcbhmr
Copy link

jcbhmr commented May 3, 2023

@Jogai you're absolutely right! Good catch 👍

Alternative image that I think works:

↖️ Click for TOC

light mode:
image

dark mode:
image

@Shishir1418
Copy link

🥰

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

15 participants