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

minor: automatic TOC structure #10

Closed
thorade opened this issue Apr 8, 2021 · 2 comments
Closed

minor: automatic TOC structure #10

thorade opened this issue Apr 8, 2021 · 2 comments

Comments

@thorade
Copy link

thorade commented Apr 8, 2021

github automatically creates a TOC
https://twitter.com/github/status/1376636651963842562
isaacs/github#215 (comment)

This is how the structure looks like currently:
image

Might be possible to resturcture to make it easier to navigate.

@greenwoodms06
Copy link
Contributor

Finally! Been looking forward to having something like that. I corrected a minor heading setup. I think with that commit the auto-readme looks ok. That auto TOC is a new feature so perhaps they might make it more feature rich in the future. Have any specific suggestion?

@thorade
Copy link
Author

thorade commented Apr 12, 2021

Maybe the only point is that the TOC has quite many levels and as a result becomes quite long. Maybe try to restrict it to TWO levels only? For example, the subsections for each tool might be overkill, as long as there are only 1-2 links in each section.

@thorade thorade closed this as completed May 7, 2021
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

2 participants