Generate docs from JSDoc comments

[Download]

I'm thinking we should make some script in package.json so we can run

npm run docs

and have it generate the human-readable docs for us. Then we can link to it from the README.

[minecrawler]

You mean have it generate docs from the source-code comments and automatically insert that into the README or a separate file? Though I think they should rather be in the README, so the docs are visible on the first page on npm.

I have never used such a tool, but sounds interesting!

[Download]

The idea of JSDoc is kinda to allow tooling to use it right? E.g. http://usejsdoc.org/about-getting-started.html#generating-a-website

I think it should be in a subfolder because the auto-generated docs are really reference-guide material, not getting-started/tutorial material.

So I think the current README is pretty ok, I just would like there be a link to the documentation that takes you to the generated docs. I think we can generate the website to some subfolder, then in the readme place a relative link to that subfolder and it would work.

I was hoping you had some experience with this part, but I think we will manage. There is no rush but it would be great if we could have this set up by the time we reach 1.0.

[minecrawler]

Unfortunately I do not have any experience with tooling to generate docs, because I always keep my code in a self-documentary way. For my projects, I always make sure that the main interface file only contains the declarations and docs, nothing more. In a way, that makes the code itself the docs, so I never had the need for a tool to convert it.

Well, let's go along with your suggestion

[Download]

If you decide to try your hands on this, let me know. Otherwise I will probably pick this up somewhere in the coming weeks.