Generate documentation in README from source files.
$ npm install -g docume
(The usage documentation below is generated via DocuMe itself. See the source of bin/docume file.)
Put some placeholders in your README file first:
# My README
Some line here...
<!--docume:path/to/source.js-->
<!--/docume:path/to/source.js-->
Author Name
It is expected that your source file would have Markdown formatted documentation as single-line comments:
/* path/to/source.js */
// this is a line that will be copied to README
var str = 'Hello World';Now run the command:
$ docume README.md
MIT © Fahad Ibnay Heylaal