nanotee / nvim-lua-guide

A guide to using Lua in Neovim
5.83k stars 220 forks source link

Add summary to readme #110

Closed ghost closed 2 years ago

ghost commented 2 years ago

Adds a summary to the readme in order to make navigation easier by letting readers choose a specific topic of their interest instead of having to scroll all the way down searching for it

I've limited the summary nesting to two levels deep to avoid making it too extensive and defeating it's own purpose of facilitating the navigation

ghost commented 2 years ago

I just noticed now that GitHub already offers a table of contents to act as a summary, but i think that having a summary would still be useful due to the following reasons:

I'll leave this up to the maintainers to judge whether or not such addition would be necessary

nanotee commented 2 years ago

I used to do this when GitHub didn't have its auto-generated TOC but found it annoying to manually re-build the TOC every time I changed a heading. I'm in favor of leaving it as-is:

ghost commented 2 years ago

Got it, thanks for the quick response! :)