Automatically build README.md Table of Contents

Right now, it looks like doctoc is used to build the table of contents. Its a npm package, and isn’t referenced in the codebase, besides the README.md. Looks like people would have to install the package manually npm install -g doctoc and then run it… I’m not sure if anyone does, or would remember to.

I think it would be cool if we could automate this somehow. Perhaps something other than doctoc could be used so that we don’t have to use npm here.

[bxm156]

Understandable, like I said, I use it at my work a lot, so I have never really had input on how others feel about it. I’m glad you brought up the concern tho because I believe it’s totally valid. I think in some ways that’s why I didn’t make a pr with it when I made this issue. If it’s not a route we want to take, that’s fine.

[scoates]

A GitHub issue probably isn’t the best medium to debate this kind of thing, but I expect someone else’s code to execute when I run a test suite. I don’t expect that code to be able to run in the future any time I use git commit. I think that’s where it breaks down for me. This is also why git does not allow the repository to directly specify the pre-commit hook, I bet.

I also think it’s different to require a team of paid developers, working on a project, to use a specific commit hook, and to expect the same thing of open source contributors.