Closed balupton closed 7 years ago
skelJS does have nice docs but wouldn't they be a tad bit difficult to implement? Also what would the content structure of the .md files of the documentation be? Perhaps it would be better to go with a .textile documentation for this since it allows much more control over the file's structure?
I just found something similar to what I said about having the code on the right side and the documentation on the left: http://raynes.github.io/lein-newnew/
@Greduan, that uses a Lisp-equivalent of Docco, which is arguably worse than JavaDocs for explaining how code works.
Oh I didn't mean actually use that. But rather I think it showed the idea quite well; code on the right and all the explanation and documentation on the left.
@SteveMcArthur did a lot of work on this over at https://github.com/docpad/website/tree/redesign
none of the original links work, so closing
These examples are nice:
Ideas:
Good guidelines for great documentation: