Add TOC to README.md

[ardumont]

Hello,

When reading readme in github, I like to be able to get directly to one
point or another without scrolling too much, I might not be alone.

This toc could help.

You can see the rendering https://github.com/ardumont/q/tree/add-toc-to-readme.

(Also this could help in copying url links)

Cheers,

[domenic]

Run M-x markdown-toc/generate-toc

How do we do this ourselves, when the readme gets changed?

[ardumont]

Hello,

How do we do this ourselves, when the readme gets changed?

as you use a node stack, you could use https://github.com/thlorenz/doctoc.

If you use emacs, you could use markdown-toc https://github.com/ardumont/markdown-toc...

There surely exists other means.

Cheers,

[domenic]

It'd be important for any PR to add a npm script that will update the ToC, so we can do npm run update-toc.

[arikon]

@ardumont @domenic We could do it like this: https://github.com/enb-bem/enb-bem-docs/pull/29/files

[domenic]

@arikon I don't think that updates the README though. And http://documentup.com/kriskowal/q/ already has a TOC, so I assume @ardumont is specifically interested in the README.

[ardumont]

@arikon I don't think that updates the README though. And http://documentup.com/kriskowal/q/ already has a TOC, so I assume @ardumont is specifically interested in the README.

Yes, indeed.
But automate this thing is a good idea for you as maintainers.