I strongly believe that documentation makes a huge difference in whether a project succeeds or fails. This is one of the reasons why I enjoy working with Ruby so much, because of the copious documentation that is easily generated by YARD. But although there are documentation tools available for Atom itself, there hasn’t been an end-to-end documentation tool like YARD for Atom packages. Until now …
Endokken is a Node.js module that you can use to easily generate static HTML documentation from your AtomDoc code documentation comments. Just call
endokken from the root directory of your Atom package and it will generate documentation in the
docs directory. You can then open
docs/README in the browser of your choice and navigate using the table-of-contents on the left.
I hope to have a sample site up soon to showcase my packages and their documentation generated by Endokken.
This is the first real Node.js module I’ve written, so feedback is welcome either here or on the Endokken issues page!