readthis takes block comments in specified .coffee or .js file(s) and outputs them in one file or on stdtout, passing through all other files types. End of story. I use it to document code in README.md-style free-form API docs.
Want to see pretty graphs? Log in now!
npm install readthis
|6||downloads in the last week|
|12||downloads in the last month|
|Last Published By|
|Version||0.0.3 last updated 2 years ago|
|Dependencies||coffee-script, falafel, optimist|
Here's how it works:
npm install -g readthis
To read a bunch of files to dump to stdout:
readthis ./some/glob/patterns/**.coffee anything.md ../bleh.js ~/code/somethingelse.js
To read a bunch of files to dump in one file:
readthis ./some/glob/patterns/**.coffee anything.md ../bleh.js ~/code/somethingelse.js -o README.md
In all your .coffee's and .js'es, leave yourself notes using inline comments, and use pure markdown to document your code in block comments.